Created index to text library for handling enumeration to text conversions.

bacnet-stack/indtext.c

@@ -0,0 +1,243 @@
+/*####COPYRIGHTBEGIN####
+ -------------------------------------------
+ Copyright (C) 2005 Steve Karg
+
+ This program is free software; you can redistribute it and/or
+ modify it under the terms of the GNU General Public License
+ as published by the Free Software Foundation; either version 2
+ of the License, or (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to 
+ The Free Software Foundation, Inc.
+ 59 Temple Place - Suite 330 
+ Boston, MA  02111-1307, USA.
+
+ As a special exception, if other files instantiate templates or
+ use macros or inline functions from this file, or you compile
+ this file and link it with other works to produce a work based
+ on this file, this file does not by itself cause the resulting
+ work to be covered by the GNU General Public License. However
+ the source code for this file must still be made available in
+ accordance with section (3) of the GNU General Public License.
+
+ This exception does not invalidate any other reasons why a work
+ based on this file might be covered by the GNU General Public
+ License.
+ -------------------------------------------
+####COPYRIGHTEND####*/
+#include <stdbool.h>
+#include <string.h>
+#include "indtext.h"
+
+#if defined(__BORLANDC__) || defined(_MSC_VER)
+#define strcasecmp stricmp
+#endif
+
+bool indtext_by_string(
+  INDTEXT_DATA *data_list,
+  const char *search_name,
+  unsigned *found_index)
+{
+  bool found = false;
+  unsigned index = 0;
+
+  if (data_list && search_name)
+  {
+    while (data_list->pString)
+    {
+      if (strcmp(data_list->pString,search_name) == 0)
+      {
+        index = data_list->index;
+        found = true;
+        break;
+      }
+      data_list++;
+    }
+  }
+
+  if (found && found_index)
+    *found_index = index;
+
+  return found;
+}
+
+/* case insensitive version */
+bool indtext_by_istring(
+  INDTEXT_DATA *data_list,
+  const char *search_name,
+  unsigned *found_index)
+{
+  bool found = false;
+  unsigned index = 0;
+
+  if (data_list && search_name)
+  {
+    while (data_list->pString)
+    {
+      if (strcasecmp(data_list->pString,search_name) == 0)
+      {
+        index = data_list->index;
+        found = true;
+        break;
+      }
+      data_list++;
+    }
+  }
+
+  if (found && found_index)
+    *found_index = index;
+
+  return found;
+}
+
+unsigned indtext_by_string_default(
+  INDTEXT_DATA *data_list,
+  const char *search_name,
+  unsigned default_index)
+{
+  unsigned index = 0;
+
+  if (!indtext_by_string(data_list,search_name,&index))
+    index = default_index;
+
+  return index;
+}
+
+unsigned indtext_by_istring_default(
+  INDTEXT_DATA *data_list,
+  const char *search_name,
+  unsigned default_index)
+{
+  unsigned index = 0;
+
+  if (!indtext_by_istring(data_list,search_name,&index))
+    index = default_index;
+
+  return index;
+}
+
+const char *indtext_by_index_default(
+  INDTEXT_DATA *data_list,
+  unsigned index,
+  const char *default_string)
+{
+  const char *pString = NULL;
+
+  if (data_list)
+  {
+    while (data_list->pString)
+    {
+      if (data_list->index == index)
+      {
+        pString = data_list->pString;
+        break;
+      }
+      data_list++;
+    }
+  }
+
+  return pString?pString:default_string;
+}
+
+const char *indtext_by_index(
+  INDTEXT_DATA *data_list,
+  unsigned index)
+{
+  return indtext_by_index_default(
+    data_list,
+    index,
+    NULL);
+}
+
+unsigned indtext_count(
+  INDTEXT_DATA *data_list)
+{
+  unsigned count = 0; /* return value */
+
+  if (data_list)
+  {
+    while (data_list->pString)
+    {
+      count++;
+      data_list++;
+    }
+  }
+  return count;
+}
+
+#ifdef TEST
+#include <assert.h>
+#include "ctest.h"
+
+static INDTEXT_DATA data_list[] =
+{
+  {1, "Joshua"},
+  {2, "Mary"},
+  {3, "Anna"},
+  {4, "Christopher"},
+  {5, "Patricia"},
+  {0, NULL}
+};
+
+void testIndexText(Test* pTest)
+{
+  unsigned i; /*counter */
+  const char *pString;
+  unsigned index;
+  bool valid;
+  unsigned count = 0;
+
+  for (i = 0; i < 10; i++)
+  {
+    pString = indtext_by_index(data_list,i);
+    if (pString)
+    {
+      count++;
+      valid = indtext_by_string(data_list,pString,&index);
+      ct_test(pTest,valid == true);
+      ct_test(pTest,index == i);
+      ct_test(pTest,index == indtext_by_string_default(data_list,pString,index));
+    }
+  }
+  ct_test(pTest,indtext_count(data_list) == count);
+  ct_test(pTest,indtext_by_string(data_list,"Harry",NULL) == false);
+  ct_test(pTest,indtext_by_string(data_list,NULL,NULL) == false);
+  ct_test(pTest,indtext_by_string(NULL,NULL,NULL) == false);
+  ct_test(pTest,indtext_by_index(data_list,0) == NULL);
+  ct_test(pTest,indtext_by_index(data_list,10) == NULL);
+  ct_test(pTest,indtext_by_index(NULL,10) == NULL);
+  /* case insensitive versions */
+  ct_test(pTest,indtext_by_istring(data_list,"JOSHUA",NULL) == true);
+  ct_test(pTest,indtext_by_istring(data_list,"joshua",NULL) == true);
+  valid = indtext_by_istring(data_list,"ANNA",&index);
+  ct_test(pTest,index == indtext_by_istring_default(data_list,"ANNA",index));
+}
+#endif
+
+#ifdef TEST_INDEX_TEXT
+int main(void)
+{
+  Test *pTest;
+  bool rc;
+
+  pTest = ct_create("index text", NULL);
+
+  /* individual tests */
+  rc = ct_addTestFunction(pTest, testIndexText);
+  assert(rc);
+
+  ct_setStream(pTest, stdout);
+  ct_run(pTest);
+  (void)ct_report(pTest);
+
+  ct_destroy(pTest);
+
+  return 0;
+}
+#endif /* TEST_INDEX_TEXT */

bacnet-stack/indtext.h

@@ -0,0 +1,99 @@
+/*####COPYRIGHTBEGIN####
+ -------------------------------------------
+ Copyright (C) 2005 Steve Karg
+
+ This program is free software; you can redistribute it and/or
+ modify it under the terms of the GNU General Public License
+ as published by the Free Software Foundation; either version 2
+ of the License, or (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to 
+ The Free Software Foundation, Inc.
+ 59 Temple Place - Suite 330 
+ Boston, MA  02111-1307, USA.
+
+ As a special exception, if other files instantiate templates or
+ use macros or inline functions from this file, or you compile
+ this file and link it with other works to produce a work based
+ on this file, this file does not by itself cause the resulting
+ work to be covered by the GNU General Public License. However
+ the source code for this file must still be made available in
+ accordance with section (3) of the GNU General Public License.
+
+ This exception does not invalidate any other reasons why a work
+ based on this file might be covered by the GNU General Public
+ License.
+ -------------------------------------------
+####COPYRIGHTEND####*/
+#ifndef INDTEXT_H
+#define INDTEXT_H
+
+#include <string.h>
+
+/* index and text pairs */
+typedef struct
+{
+  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);
+/* returns the number of elements in the list */
+unsigned indtext_count(
+  INDTEXT_DATA *data_list);
+
+#ifdef TEST
+  #include "ctest.h"
+  void testIndexText(Test* pTest);
+#endif
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+
+#endif

bacnet-stack/indtext.mak

@@ -0,0 +1,28 @@
+#Makefile to build unit tests
+CC      = gcc
+BASEDIR = .
+CFLAGS  = -Wall -I. -Itest -g -DTEST -DTEST_INDEX_TEXT
+
+TARGET = indtext
+
+SRCS = indtext.c \
+       test/ctest.c
+
+OBJS = ${SRCS:.c=.o}
+
+all: ${TARGET}
+ 
+${TARGET}: ${OBJS}
+	${CC} -o $@ ${OBJS} 
+
+.c.o:
+	${CC} -c ${CFLAGS} $*.c -o $@
+	
+depend:
+	rm -f .depend
+	${CC} -MM ${CFLAGS} *.c >> .depend
+	
+clean:
+	rm -rf core ${OBJS} ${TARGET} *.bak
+
+include: .depend

bacnet-stack/test.sh

@@ -89,5 +89,7 @@ make -f address.mak
 ./address >> test.log
 make -f address.mak clean
 
-
+make -f indtext.mak clean
-
+make -f indtext.mak
+./indtext >> test.log
+make -f indtext.mak clean