text: /**************************************************************************
  *
  * Copyright (C) 2012 Steve Karg <skarg@users.sourceforge.net>
  *
  * Permission is hereby granted, free of charge, to any person obtaining
  * a copy of this software and associated documentation files (the
  * "Software"), to deal in the Software without restriction, including
  * without limitation the rights to use, copy, modify, merge, publish,
  * distribute, sublicense, and/or sell copies of the Software, and to
  * permit persons to whom the Software is furnished to do so, subject to
  * the following conditions:
  *
  * The above copyright notice and this permission notice shall be included
  * in all copies or substantial portions of the Software.
  *
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  *********************************************************************/
  #ifndef INDTEXT_H
  #define INDTEXT_H
  
  #include <stdbool.h>
  #include <stdint.h>
  #include <string.h>
  
  /* index and text pairs */
  typedef const struct {
      const unsigned index;     /* index number that matches the text */
      const char *pString;        /* text pair - use NULL to end the list */
  } INDTEXT_DATA;
  
  #ifdef __cplusplus
  extern "C" {
  #endif /* __cplusplus */
  
  /*  Searches for a matching string and returns the index to the string
      in the parameter found_index.
      If the string is not found, false is returned
      If the string is found, true is returned and the found_index contains
      the first index where the string was found. */
      bool indtext_by_string(
          INDTEXT_DATA * data_list,
          const char *search_name,
          unsigned *found_index);
  /* case insensitive version */
      bool indtext_by_istring(
          INDTEXT_DATA * data_list,
          const char *search_name,
          unsigned *found_index);
  /*  Searches for a matching string and returns the index to the string
      or the default_index if the string is not found. */
      unsigned indtext_by_string_default(
          INDTEXT_DATA * data_list,
          const char *search_name,
          unsigned default_index);
  /* case insensitive version */
      unsigned indtext_by_istring_default(
          INDTEXT_DATA * data_list,
          const char *search_name,
          unsigned default_index);
  /* for a given index, return the matching string,
     or NULL if not found */
      const char *indtext_by_index(
          INDTEXT_DATA * data_list,
          unsigned index);
  /* for a given index, return the matching string,
     or default_name if not found */
      const char *indtext_by_index_default(
          INDTEXT_DATA * data_list,
          unsigned index,
          const char *default_name);
  /* for a given index, return the matching string,
     or default_name if not found.
     if the index is before the split,
     the before_split_default_name is used */
      const char *indtext_by_index_split_default(
          INDTEXT_DATA * data_list,
          unsigned index,
          unsigned split_index,
          const char *before_split_default_name,
          const char *default_name);
  
  /* returns the number of elements in the list */
      unsigned indtext_count(
          INDTEXT_DATA * data_list);
  
  
  #if !defined(__BORLANDC__) && !defined(_MSC_VER)
      int stricmp(
          const char *s1,
          const char *s2);
  #endif
  
  #ifdef TEST
  #include "ctest.h"
      void testIndexText(
          Test * pTest);
  #endif
  
  #ifdef __cplusplus
  }
  #endif /* __cplusplus */
  #endif
  