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

   1 /*
   2   Copyright 1999-2014 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 #include "MagickCore/exception.h"
  22
  23 #if defined(__cplusplus) || defined(c_plusplus)
  24 extern "C" {
  25 #endif
  26
  27 typedef struct _StringInfo
  28 {
  29   char
  30     path[MaxTextExtent];
  31
  32   unsigned char
  33     *datum;
  34
  35   size_t
  36     length,
  37     signature;
  38 } StringInfo;
  39
  40 extern MagickExport char
  41   *AcquireString(const char *),
  42   *CloneString(char **,const char *),
  43   *ConstantString(const char *),
  44   *DestroyString(char *),
  45   **DestroyStringList(char **),
  46   *EscapeString(const char *,const char),
  47   *FileToString(const char *,const size_t,ExceptionInfo *),
  48   *GetEnvironmentValue(const char *),
  49   *StringInfoToHexString(const StringInfo *),
  50   *StringInfoToString(const StringInfo *),
  51   **StringToArgv(const char *,int *),
  52   *StringToken(const char *,char **),
  53   **StringToList(const char *);
  54
  55 extern MagickExport const char
  56   *GetStringInfoPath(const StringInfo *);
  57
  58 extern MagickExport double
  59   InterpretSiPrefixValue(const char *restrict,char **restrict),
  60   *StringToArrayOfDoubles(const char *,ssize_t *,ExceptionInfo *);
  61
  62 extern MagickExport int
  63   CompareStringInfo(const StringInfo *,const StringInfo *),
  64   LocaleCompare(const char *,const char *),
  65   LocaleNCompare(const char *,const char *,const size_t);
  66
  67 extern MagickExport MagickBooleanType
  68   ConcatenateString(char **,const char *),
  69   IsStringTrue(const char *),
  70   IsStringNotFalse(const char *),
  71   SubstituteString(char **,const char *,const char *);
  72
  73 extern MagickExport size_t
  74   ConcatenateMagickString(char *,const char *,const size_t)
  75     magick_attribute((__nonnull__)),
  76   CopyMagickString(char *,const char *,const size_t)
  77     magick_attribute((__nonnull__)),
  78   GetStringInfoLength(const StringInfo *);
  79
  80 extern MagickExport ssize_t
  81   FormatMagickSize(const MagickSizeType,const MagickBooleanType,char *),
  82   FormatMagickTime(const time_t,const size_t,char *);
  83
  84 extern MagickExport StringInfo
  85   *AcquireStringInfo(const size_t),
  86   *BlobToStringInfo(const void *,const size_t),
  87   *CloneStringInfo(const StringInfo *),
  88   *ConfigureFileToStringInfo(const char *),
  89   *DestroyStringInfo(StringInfo *),
  90   *FileToStringInfo(const char *,const size_t,ExceptionInfo *),
  91   *SplitStringInfo(StringInfo *,const size_t),
  92   *StringToStringInfo(const char *);
  93
  94 extern MagickExport unsigned char
  95   *GetStringInfoDatum(const StringInfo *);
  96
  97 extern MagickExport void
  98   ConcatenateStringInfo(StringInfo *,const StringInfo *)
  99     magick_attribute((__nonnull__)),
 100   LocaleLower(char *),
 101   LocaleUpper(char *),
 102   PrintStringInfo(FILE *file,const char *,const StringInfo *),
 103   ResetStringInfo(StringInfo *),
 104   SetStringInfo(StringInfo *,const StringInfo *),
 105   SetStringInfoDatum(StringInfo *,const unsigned char *),
 106   SetStringInfoLength(StringInfo *,const size_t),
 107   SetStringInfoPath(StringInfo *,const char *),
 108   StripString(char *);
 109
 110 #if defined(__cplusplus) || defined(c_plusplus)
 111 }
 112 #endif
 113
 114 #endif