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