granicus.if.org Git - imagemagick/blob - magick/string_.h

   1 /*
   2   Copyright 1999-2010 ImageMagick Studio LLC, a non-profit organization
   3   dedicated to making software imaging solutions freely available.
   4
   5   You may not use this file except in compliance with the License.
   6   obtain a copy of the License at
   7
   8     http://www.imagemagick.org/script/license.php
   9
  10   Unless required by applicable law or agreed to in writing, software
  11   distributed under the License is distributed on an "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13   See the License for the specific language governing permissions and
  14   limitations under the License.
  15
  16   MagickCore string methods.
  17 */
  18 #ifndef _MAGICKCORE_STRING_H_
  19 #define _MAGICKCORE_STRING_H_
  20
  21 #if defined(__cplusplus) || defined(c_plusplus)
  22 extern "C" {
  23 #endif
  24
  25 #include <stdarg.h>
  26 #include <time.h>
  27 #include "magick/exception.h"
  28
  29 typedef struct _StringInfo
  30 {
  31   char
  32     path[MaxTextExtent];
  33
  34   unsigned char
  35     *datum;
  36
  37   size_t
  38     length;
  39
  40   unsigned long
  41     signature;
  42 } StringInfo;
  43
  44 extern MagickExport char
  45   *AcquireString(const char *),
  46   *CloneString(char **,const char *),
  47   *ConstantString(const char *),
  48   *DestroyString(char *),
  49   **DestroyStringList(char **),
  50   *EscapeString(const char *,const char),
  51   *FileToString(const char *,const size_t,ExceptionInfo *),
  52   *GetEnvironmentValue(const char *),
  53   *StringInfoToHexString(const StringInfo *),
  54   *StringInfoToString(const StringInfo *),
  55   **StringToArgv(const char *,int *),
  56   *StringToken(const char *,char **),
  57   **StringToList(const char *);
  58
  59 extern MagickExport const char
  60   *GetStringInfoPath(const StringInfo *);
  61
  62 extern MagickExport double
  63   StringToDouble(const char *,const double);
  64
  65 extern MagickExport long
  66   FormatMagickSize(const MagickSizeType,const MagickBooleanType,char *),
  67   FormatMagickString(char *,const size_t,const char *,...)
  68     magick_attribute((format (printf,3,4))),
  69   FormatMagickStringList(char *,const size_t,const char *,va_list)
  70     magick_attribute((format (printf,3,0))),
  71   FormatMagickTime(const time_t,const size_t,char *),
  72   LocaleCompare(const char *,const char *),
  73   LocaleNCompare(const char *,const char *,const size_t);
  74
  75 extern MagickExport MagickBooleanType
  76   ConcatenateString(char **,const char *),
  77   SubstituteString(char **,const char *,const char *);
  78
  79 extern MagickExport int
  80   CompareStringInfo(const StringInfo *,const StringInfo *);
  81
  82 extern MagickExport size_t
  83   ConcatenateMagickString(char *,const char *,const size_t)
  84     magick_attribute((nonnull)),
  85   CopyMagickString(char *,const char *,const size_t)
  86     magick_attribute((nonnull)),
  87   GetStringInfoLength(const StringInfo *);
  88
  89 extern MagickExport StringInfo
  90   *AcquireStringInfo(const size_t),
  91   *CloneStringInfo(const StringInfo *),
  92   *ConfigureFileToStringInfo(const char *),
  93   *DestroyStringInfo(StringInfo *),
  94   *FileToStringInfo(const char *,const size_t,ExceptionInfo *),
  95   *SplitStringInfo(StringInfo *,const size_t),
  96   *StringToStringInfo(const char *);
  97
  98 extern MagickExport unsigned char
  99   *GetStringInfoDatum(const StringInfo *);
 100
 101 extern MagickExport void
 102   ConcatenateStringInfo(StringInfo *,const StringInfo *)
 103     magick_attribute((nonnull)),
 104   LocaleLower(char *),
 105   LocaleUpper(char *),
 106   PrintStringInfo(FILE *file,const char *,const StringInfo *),
 107   ResetStringInfo(StringInfo *),
 108   SetStringInfo(StringInfo *,const StringInfo *),
 109   SetStringInfoDatum(StringInfo *,const unsigned char *),
 110   SetStringInfoLength(StringInfo *,const size_t),
 111   SetStringInfoPath(StringInfo *,const char *),
 112   StripString(char *);
 113
 114 #if defined(__cplusplus) || defined(c_plusplus)
 115 }
 116 #endif
 117
 118 #endif