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

   1 /*
   2   Copyright 1999-2011 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     signature;
  40 } StringInfo;
  41
  42 extern MagickExport char
  43   *AcquireString(const char *),
  44   *CloneString(char **,const char *),
  45   *ConstantString(const char *),
  46   *DestroyString(char *),
  47   **DestroyStringList(char **),
  48   *EscapeString(const char *,const char),
  49   *FileToString(const char *,const size_t,ExceptionInfo *),
  50   *GetEnvironmentValue(const char *),
  51   *StringInfoToHexString(const StringInfo *),
  52   *StringInfoToString(const StringInfo *),
  53   **StringToArgv(const char *,int *),
  54   *StringToken(const char *,char **),
  55   **StringToList(const char *);
  56
  57 extern MagickExport const char
  58   *GetStringInfoPath(const StringInfo *);
  59
  60 extern MagickExport int
  61   CompareStringInfo(const StringInfo *,const StringInfo *),
  62   LocaleCompare(const char *,const char *),
  63   LocaleNCompare(const char *,const char *,const size_t);
  64
  65 extern MagickExport MagickBooleanType
  66   ConcatenateString(char **,const char *),
  67   SubstituteString(char **,const char *,const char *);
  68
  69 extern MagickExport size_t
  70   ConcatenateMagickString(char *,const char *,const size_t)
  71     magick_attribute((nonnull)),
  72   CopyMagickString(char *,const char *,const size_t)
  73     magick_attribute((nonnull)),
  74   GetStringInfoLength(const StringInfo *);
  75
  76 extern MagickExport ssize_t
  77   FormatMagickSize(const MagickSizeType,const MagickBooleanType,char *),
  78   FormatMagickString(char *,const size_t,const char *,...)
  79     magick_attribute((format (printf,3,4))),
  80   FormatMagickStringList(char *,const size_t,const char *,va_list)
  81     magick_attribute((format (printf,3,0))),
  82   FormatMagickTime(const time_t,const size_t,char *);
  83
  84 extern MagickExport StringInfo
  85   *AcquireStringInfo(const size_t),
  86   *CloneStringInfo(const StringInfo *),
  87   *ConfigureFileToStringInfo(const char *),
  88   *DestroyStringInfo(StringInfo *),
  89   *FileToStringInfo(const char *,const size_t,ExceptionInfo *),
  90   *SplitStringInfo(StringInfo *,const size_t),
  91   *StringToStringInfo(const char *);
  92
  93 extern MagickExport unsigned char
  94   *GetStringInfoDatum(const StringInfo *);
  95
  96 extern MagickExport void
  97   ConcatenateStringInfo(StringInfo *,const StringInfo *)
  98     magick_attribute((nonnull)),
  99   LocaleLower(char *),
 100   LocaleUpper(char *),
 101   PrintStringInfo(FILE *file,const char *,const StringInfo *),
 102   ResetStringInfo(StringInfo *),
 103   SetStringInfo(StringInfo *,const StringInfo *),
 104   SetStringInfoDatum(StringInfo *,const unsigned char *),
 105   SetStringInfoLength(StringInfo *,const size_t),
 106   SetStringInfoPath(StringInfo *,const char *),
 107   StripString(char *);
 108
 109 #if defined(__cplusplus) || defined(c_plusplus)
 110 }
 111 #endif
 112
 113 #endif