src/Objects/General/String/doc/String.html

   1 <HTML>
   2 <HEAD>
   3 <TITLE> String </TITLE>
   4 </HEAD>
   5 <BODY BGCOLOR="ffffcc">
   6 <H1> String </H1>
   7 <H2> Member function </H2>
   8 <UL>
   9         <LI> stringGetFromFile
  10         <LI> stringGetNthWord
  11         <LI> stringGetNthRealData
  12         <LI> stringGetNthIntegerData
  13         <LI> stringIsSame
  14         <LI> stringLength
  15         <LI> stringCopy
  16 </UL>
  17 <HR>
  18 <A NAME="Information">
  19 <H2>Information from source codes</H2>
  20 </A>
  21 <PRE>
  22 ../src/stringGet.c:
  23
  24 ../src/stringGetFromFile.c:
  25
  26 ../src/stringIsSame.c:
  27
  28 ../src/stringUtil.c:
  29 </PRE>
  30 <HR>
  31 <A NAME="include">
  32 <H2>String.h</H2>
  33 </A>
  34 <PRE>
  35 #ifndef STRING_H
  36 #define STRING_H
  37 #include <stdio.h>
  38
  39 /* constant begin */
  40 #define STRING_MAX_LENGTH (8192)
  41 #define STRING_WORD_SEPARATOR  " ,\t"
  42 #define STRING_COMMENT_LINE_ID '#'
  43 /* constant end */
  44
  45 /* struct begin */
  46 typedef char*         String;
  47 typedef unsigned long stringParaTypeInteger;
  48 typedef float         stringParaTypeReal;
  49 /* struct end */
  50
  51 #ifdef __cplusplus
  52 extern "C" {
  53 #endif
  54
  55 /* prototype begin */
  56 extern void stringInit(String s, char* message);
  57
  58 /*
  59         mode&0x01 := 0: quary   1: no quary
  60         mode&0x02 := 0: message 1: no message
  61 */
  62 extern String stringGetFromFile(char* s, char* message, FILE* fptIn, FILE* fptOut, long mode);
  63 extern String stringGetFromFileWithSkippingComment(char* s, char* message, FILE* fptIn, FILE* fptOut, long mode);
  64 extern char* __getStringData(char* s, char* message, FILE* fptIn, FILE* fptOut, long mode);
  65
  66 extern String stringGetNthWord(char* s, long nth, char* exception);
  67 extern double stringGetNthRealData(char* s, long nth, char* exception);
  68 extern long   stringGetNthIntegerData(char* s, long nth, char* exception);
  69
  70 extern String stringGetWordFromField(char* s, long init, long end);
  71 extern double stringGetRealDataFromField(char* s, long init, long end);
  72 extern long   stringGetIntegerDataFromField(char* s, long init, long end);
  73
  74 extern long stringIsSame(String s1, String s2, long n);
  75
  76 extern long stringLength(String s);
  77 extern long stringCopy(String dst, String src, long n);
  78 extern String stringDuplicate(String src);
  79
  80 /* prototype end */
  81
  82 #ifdef __cplusplus
  83 };
  84 #endif
  85
  86 #endif /* STRING_H */
  87 </PRE>
  88 </BODY>
  89 </HTML>