apt-pkg/contrib/strutl.h

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 // $Id: strutl.h,v 1.22 2003/02/02 22:20:27 jgg Exp $
   4 /* ######################################################################
   5
   6    String Util - These are some useful string functions
   7
   8    _strstrip is a function to remove whitespace from the front and end
   9    of a string.
  10
  11    This source is placed in the Public Domain, do with it what you will
  12    It was originally written by Jason Gunthorpe <jgg@gpu.srv.ualberta.ca>
  13
  14    ##################################################################### */
  15                                                                         /*}}}*/
  16 #ifndef STRUTL_H
  17 #define STRUTL_H
  18
  19 #ifdef __GNUG__
  20 #pragma interface "apt-pkg/strutl.h"
  21 #endif
  22
  23 #include <stdlib.h>
  24 #include <string>
  25 #include <vector>
  26 #include <iostream>
  27 #include <time.h>
  28
  29 using std::string;
  30 using std::vector;
  31 using std::ostream;
  32
  33 #ifdef __GNUG__
  34 // Methods have a hidden this parameter that is visible to this attribute
  35 #define APT_FORMAT2 __attribute__ ((format (printf, 2, 3)))
  36 #define APT_FORMAT3 __attribute__ ((format (printf, 3, 4)))
  37 #else
  38 #define APT_FORMAT2
  39 #define APT_FORMAT3
  40 #endif
  41
  42 bool UTF8ToCodeset(const char *codeset, const string &orig, string *dest);
  43 char *_strstrip(char *String);
  44 char *_strtabexpand(char *String,size_t Len);
  45 bool ParseQuoteWord(const char *&String,string &Res);
  46 bool ParseCWord(const char *&String,string &Res);
  47 string QuoteString(string Str,const char *Bad);
  48 string DeQuoteString(string Str);
  49 string SizeToStr(double Bytes);
  50 string TimeToStr(unsigned long Sec);
  51 string Base64Encode(string Str);
  52 string URItoFileName(string URI);
  53 string TimeRFC1123(time_t Date);
  54 bool StrToTime(string Val,time_t &Result);
  55 string LookupTag(string Message,const char *Tag,const char *Default = 0);
  56 int StringToBool(string Text,int Default = -1);
  57 bool ReadMessages(int Fd, vector<string> &List);
  58 bool StrToNum(const char *Str,unsigned long &Res,unsigned Len,unsigned Base = 0);
  59 bool Hex2Num(string Str,unsigned char *Num,unsigned int Length);
  60 bool TokSplitString(char Tok,char *Input,char **List,
  61                     unsigned long ListMax);
  62 void ioprintf(ostream &out,const char *format,...) APT_FORMAT2;
  63 char *safe_snprintf(char *Buffer,char *End,const char *Format,...) APT_FORMAT3;
  64 bool CheckDomainList(string Host,string List);
  65
  66 #define APT_MKSTRCMP(name,func) \
  67 inline int name(const char *A,const char *AEnd,const char *B) {return func(A,AEnd,B,B+strlen(B));}; \
  68 inline int name(string A,const char *B) {return func(A.c_str(),A.c_str()+A.length(),B,B+strlen(B));}; \
  69 inline int name(string A,string B) {return func(A.c_str(),A.c_str()+A.length(),B.c_str(),B.c_str()+B.length());}; \
  70 inline int name(string A,const char *B,const char *BEnd) {return func(A.c_str(),A.c_str()+A.length(),B,BEnd);};
  71
  72 #define APT_MKSTRCMP2(name,func) \
  73 inline int name(const char *A,const char *AEnd,const char *B) {return func(A,AEnd,B,B+strlen(B));}; \
  74 inline int name(string A,const char *B) {return func(A.begin(),A.end(),B,B+strlen(B));}; \
  75 inline int name(string A,string B) {return func(A.begin(),A.end(),B.begin(),B.end());}; \
  76 inline int name(string A,const char *B,const char *BEnd) {return func(A.begin(),A.end(),B,BEnd);};
  77
  78 int stringcmp(const char *A,const char *AEnd,const char *B,const char *BEnd);
  79 int stringcasecmp(const char *A,const char *AEnd,const char *B,const char *BEnd);
  80
  81 /* We assume that GCC 3 indicates that libstdc++3 is in use too. In that
  82    case the definition of string::const_iterator is not the same as
  83    const char * and we need these extra functions */
  84 #if __GNUC__ >= 3
  85 int stringcmp(string::const_iterator A,string::const_iterator AEnd,
  86               const char *B,const char *BEnd);
  87 int stringcmp(string::const_iterator A,string::const_iterator AEnd,
  88               string::const_iterator B,string::const_iterator BEnd);
  89 int stringcasecmp(string::const_iterator A,string::const_iterator AEnd,
  90                   const char *B,const char *BEnd);
  91 int stringcasecmp(string::const_iterator A,string::const_iterator AEnd,
  92                   string::const_iterator B,string::const_iterator BEnd);
  93
  94 inline int stringcmp(string::const_iterator A,string::const_iterator Aend,const char *B) {return stringcmp(A,Aend,B,B+strlen(B));};
  95 inline int stringcasecmp(string::const_iterator A,string::const_iterator Aend,const char *B) {return stringcasecmp(A,Aend,B,B+strlen(B));};
  96 #endif
  97
  98 APT_MKSTRCMP2(stringcmp,stringcmp);
  99 APT_MKSTRCMP2(stringcasecmp,stringcasecmp);
 100
 101 inline const char *DeNull(const char *s) {return (s == 0?"(null)":s);};
 102
 103 class URI
 104 {
 105    void CopyFrom(string From);
 106
 107    public:
 108
 109    string Access;
 110    string User;
 111    string Password;
 112    string Host;
 113    string Path;
 114    unsigned int Port;
 115
 116    operator string();
 117    inline void operator =(string From) {CopyFrom(From);};
 118    inline bool empty() {return Access.empty();};
 119    static string SiteOnly(string URI);
 120
 121    URI(string Path) {CopyFrom(Path);};
 122    URI() : Port(0) {};
 123 };
 124
 125 struct SubstVar
 126 {
 127    const char *Subst;
 128    const string *Contents;
 129 };
 130 string SubstVar(string Str,const struct SubstVar *Vars);
 131 string SubstVar(string Str,string Subst,string Contents);
 132
 133 struct RxChoiceList
 134 {
 135    void *UserData;
 136    const char *Str;
 137    bool Hit;
 138 };
 139 unsigned long RegexChoice(RxChoiceList *Rxs,const char **ListBegin,
 140                       const char **ListEnd);
 141
 142 #undef APT_FORMAT2
 143
 144 #endif