string_.h

Go to the documentation of this file.
00001 /*
00002   Copyright 1999-2009 ImageMagick Studio LLC, a non-profit organization
00003   dedicated to making software imaging solutions freely available.
00004   
00005   You may not use this file except in compliance with the License.
00006   obtain a copy of the License at
00007   
00008     http://www.imagemagick.org/script/license.php
00009   
00010   Unless required by applicable law or agreed to in writing, software
00011   distributed under the License is distributed on an "AS IS" BASIS,
00012   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013   See the License for the specific language governing permissions and
00014   limitations under the License.
00015 
00016   MagickCore string methods.
00017 */
00018 #ifndef _MAGICKCORE_STRING_H_
00019 #define _MAGICKCORE_STRING_H_
00020 
00021 #if defined(__cplusplus) || defined(c_plusplus)
00022 extern "C" {
00023 #endif
00024 
00025 #include <stdarg.h>
00026 #include <time.h>
00027 #include "magick/exception.h"
00028 
00029 typedef struct _StringInfo
00030 {
00031   char
00032     path[MaxTextExtent];
00033 
00034   unsigned char
00035     *datum;
00036 
00037   size_t
00038     length;
00039 
00040   unsigned long
00041     signature;
00042 } StringInfo;
00043 
00044 extern MagickExport char
00045   *AcquireString(const char *),
00046   *CloneString(char **,const char *),
00047   *ConstantString(const char *),
00048   *DestroyString(char *),
00049   **DestroyStringList(char **),
00050   *EscapeString(const char *,const char),
00051   *FileToString(const char *,const size_t,ExceptionInfo *),
00052   *GetEnvironmentValue(const char *),
00053   *StringInfoToHexString(const StringInfo *),
00054   *StringInfoToString(const StringInfo *),
00055   **StringToArgv(const char *,int *),
00056   *StringToken(const char *,char **),
00057   **StringToList(const char *);
00058 
00059 extern MagickExport const char
00060   *GetStringInfoPath(const StringInfo *);
00061 
00062 extern MagickExport double
00063   StringToDouble(const char *,const double);
00064 
00065 extern MagickExport long
00066   FormatMagickSize(const MagickSizeType,char *),
00067   FormatMagickString(char *,const size_t,const char *,...)
00068     magick_attribute((format (printf,3,4))),
00069   FormatMagickStringList(char *,const size_t,const char *,va_list)
00070     magick_attribute((format (printf,3,0))),
00071   FormatMagickTime(const time_t,const size_t,char *),
00072   LocaleCompare(const char *,const char *),
00073   LocaleNCompare(const char *,const char *,const size_t);
00074 
00075 extern MagickExport MagickBooleanType
00076   ConcatenateString(char **,const char *),
00077   SubstituteString(char **,const char *,const char *);
00078 
00079 extern MagickExport int
00080   CompareStringInfo(const StringInfo *,const StringInfo *);
00081 
00082 extern MagickExport size_t
00083   ConcatenateMagickString(char *,const char *,const size_t)
00084     magick_attribute((nonnull)),
00085   CopyMagickString(char *,const char *,const size_t)
00086     magick_attribute((nonnull)),
00087   GetStringInfoLength(const StringInfo *);
00088 
00089 extern MagickExport StringInfo
00090   *AcquireStringInfo(const size_t),
00091   *CloneStringInfo(const StringInfo *),
00092   *ConfigureFileToStringInfo(const char *),
00093   *DestroyStringInfo(StringInfo *),
00094   *FileToStringInfo(const char *,const size_t,ExceptionInfo *),
00095   *SplitStringInfo(StringInfo *,const size_t),
00096   *StringToStringInfo(const char *);
00097 
00098 extern MagickExport unsigned char
00099   *GetStringInfoDatum(const StringInfo *);
00100 
00101 extern MagickExport void
00102   ConcatenateStringInfo(StringInfo *,const StringInfo *)
00103     magick_attribute((nonnull)),
00104   LocaleLower(char *),
00105   LocaleUpper(char *),
00106   PrintStringInfo(FILE *file,const char *,const StringInfo *),
00107   ResetStringInfo(StringInfo *),
00108   SetStringInfo(StringInfo *,const StringInfo *),
00109   SetStringInfoDatum(StringInfo *,const unsigned char *),
00110   SetStringInfoLength(StringInfo *,const size_t),
00111   SetStringInfoPath(StringInfo *,const char *),
00112   StripString(char *);
00113 
00114 #if defined(__cplusplus) || defined(c_plusplus)
00115 }
00116 #endif
00117 
00118 #endif