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

   1 /*
   2   Copyright 1999-2012 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 "MagickCore/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 double
  61   InterpretSiPrefixValue(const char *restrict,char **restrict),
  62   *StringToArrayOfDoubles(const char *,ssize_t *, ExceptionInfo *);
  63
  64 extern MagickExport int
  65   CompareStringInfo(const StringInfo *,const StringInfo *),
  66   LocaleCompare(const char *,const char *),
  67   LocaleNCompare(const char *,const char *,const size_t);
  68
  69 extern MagickExport MagickBooleanType
  70   ConcatenateString(char **,const char *),
  71   IsStringTrue(const char *),
  72   IsStringNotFalse(const char *),
  73   SubstituteString(char **,const char *,const char *);
  74
  75 extern MagickExport size_t
  76   ConcatenateMagickString(char *,const char *,const size_t)
  77     magick_attribute((__nonnull__)),
  78   CopyMagickString(char *,const char *,const size_t)
  79     magick_attribute((__nonnull__)),
  80   GetStringInfoLength(const StringInfo *);
  81
  82 extern MagickExport ssize_t
  83   FormatMagickSize(const MagickSizeType,const MagickBooleanType,char *),
  84   FormatMagickTime(const time_t,const size_t,char *);
  85
  86 extern MagickExport StringInfo
  87   *AcquireStringInfo(const size_t),
  88   *BlobToStringInfo(const void *,const size_t),
  89   *CloneStringInfo(const StringInfo *),
  90   *ConfigureFileToStringInfo(const char *),
  91   *DestroyStringInfo(StringInfo *),
  92   *FileToStringInfo(const char *,const size_t,ExceptionInfo *),
  93   *SplitStringInfo(StringInfo *,const size_t),
  94   *StringToStringInfo(const char *);
  95
  96 extern MagickExport unsigned char
  97   *GetStringInfoDatum(const StringInfo *);
  98
  99 extern MagickExport void
 100   ConcatenateStringInfo(StringInfo *,const StringInfo *)
 101     magick_attribute((__nonnull__)),
 102   LocaleLower(char *),
 103   LocaleUpper(char *),
 104   PrintStringInfo(FILE *file,const char *,const StringInfo *),
 105   ResetStringInfo(StringInfo *),
 106   SetStringInfo(StringInfo *,const StringInfo *),
 107   SetStringInfoDatum(StringInfo *,const unsigned char *),
 108   SetStringInfoLength(StringInfo *,const size_t),
 109   SetStringInfoPath(StringInfo *,const char *),
 110   StripString(char *);
 111
 112 #if defined(__cplusplus) || defined(c_plusplus)
 113 }
 114 #endif
 115
 116 #endif