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
  20 #include <limits>
  21 #include <string>
  22 #include <cstring>
  23 #include <vector>
  24 #include <iostream>
  25 #include <time.h>
  26 #include <stddef.h>
  27
  28 #include "macros.h"
  29
  30 #ifndef APT_10_CLEANER_HEADERS
  31 #include <stdlib.h>
  32 #endif
  33 #ifndef APT_8_CLEANER_HEADERS
  34 using std::string;
  35 using std::vector;
  36 using std::ostream;
  37 #endif
  38
  39 namespace APT {
  40    namespace String {
  41       std::string Strip(const std::string &s);
  42       bool Endswith(const std::string &s, const std::string &ending);
  43       bool Startswith(const std::string &s, const std::string &starting);
  44    }
  45 }
  46
  47
  48 bool UTF8ToCodeset(const char *codeset, const std::string &orig, std::string *dest);
  49 char *_strstrip(char *String);
  50 char *_strrstrip(char *String); // right strip only
  51 char *_strtabexpand(char *String,size_t Len);
  52 bool ParseQuoteWord(const char *&String,std::string &Res);
  53 bool ParseCWord(const char *&String,std::string &Res);
  54 std::string QuoteString(const std::string &Str,const char *Bad);
  55 std::string DeQuoteString(const std::string &Str);
  56 std::string DeQuoteString(std::string::const_iterator const &begin, std::string::const_iterator const &end);
  57
  58 // unescape (\0XX and \xXX) from a string
  59 std::string DeEscapeString(const std::string &input);
  60
  61 std::string SizeToStr(double Bytes);
  62 std::string TimeToStr(unsigned long Sec);
  63 std::string Base64Encode(const std::string &Str);
  64 std::string OutputInDepth(const unsigned long Depth, const char* Separator="  ");
  65 std::string URItoFileName(const std::string &URI);
  66 std::string TimeRFC1123(time_t Date);
  67 bool RFC1123StrToTime(const char* const str,time_t &time) APT_MUSTCHECK;
  68 bool FTPMDTMStrToTime(const char* const str,time_t &time) APT_MUSTCHECK;
  69 APT_DEPRECATED_MSG("Use RFC1123StrToTime or FTPMDTMStrToTime as needed instead") bool StrToTime(const std::string &Val,time_t &Result);
  70 std::string LookupTag(const std::string &Message,const char *Tag,const char *Default = 0);
  71 int StringToBool(const std::string &Text,int Default = -1);
  72 bool ReadMessages(int Fd, std::vector<std::string> &List);
  73 bool StrToNum(const char *Str,unsigned long &Res,unsigned Len,unsigned Base = 0);
  74 bool StrToNum(const char *Str,unsigned long long &Res,unsigned Len,unsigned Base = 0);
  75 bool Base256ToNum(const char *Str,unsigned long &Res,unsigned int Len);
  76 bool Base256ToNum(const char *Str,unsigned long long &Res,unsigned int Len);
  77 bool Hex2Num(const std::string &Str,unsigned char *Num,unsigned int Length);
  78
  79 // input changing string split
  80 bool TokSplitString(char Tok,char *Input,char **List,
  81                     unsigned long ListMax);
  82
  83 // split a given string by a char
  84 std::vector<std::string> VectorizeString(std::string const &haystack, char const &split) APT_PURE;
  85
  86 /* \brief Return a vector of strings from string "input" where "sep"
  87  * is used as the delimiter string.
  88  *
  89  * \param input The input string.
  90  *
  91  * \param sep The seperator to use.
  92  *
  93  * \param maxsplit (optional) The maximum amount of splitting that
  94  * should be done .
  95  *
  96  * The optional "maxsplit" argument can be used to limit the splitting,
  97  * if used the string is only split on maxsplit places and the last
  98  * item in the vector contains the remainder string.
  99  */
 100 std::vector<std::string> StringSplit(std::string const &input,
 101                                      std::string const &sep,
 102                                      unsigned int maxsplit=std::numeric_limits<unsigned int>::max()) APT_CONST;
 103
 104 void ioprintf(std::ostream &out,const char *format,...) APT_PRINTF(2);
 105 void strprintf(std::string &out,const char *format,...) APT_PRINTF(2);
 106 char *safe_snprintf(char *Buffer,char *End,const char *Format,...) APT_PRINTF(3);
 107 bool CheckDomainList(const std::string &Host, const std::string &List);
 108
 109 /* Do some compat mumbo jumbo */
 110 #define tolower_ascii  tolower_ascii_inline
 111 #define isspace_ascii  isspace_ascii_inline
 112
 113 APT_CONST APT_HOT
 114 static inline int tolower_ascii_inline(int const c)
 115 {
 116    return (c >= 'A' && c <= 'Z') ? c + 32 : c;
 117 }
 118 APT_CONST APT_HOT
 119 static inline int isspace_ascii_inline(int const c)
 120 {
 121    // 9='\t',10='\n',11='\v',12='\f',13='\r',32=' '
 122    return (c >= 9 && c <= 13) || c == ' ';
 123 }
 124
 125 std::string StripEpoch(const std::string &VerStr);
 126
 127 #define APT_MKSTRCMP(name,func) \
 128 inline APT_PURE int name(const char *A,const char *B) {return func(A,A+strlen(A),B,B+strlen(B));} \
 129 inline APT_PURE int name(const char *A,const char *AEnd,const char *B) {return func(A,AEnd,B,B+strlen(B));} \
 130 inline APT_PURE int name(const std::string& A,const char *B) {return func(A.c_str(),A.c_str()+A.length(),B,B+strlen(B));} \
 131 inline APT_PURE int name(const std::string& A,const std::string& B) {return func(A.c_str(),A.c_str()+A.length(),B.c_str(),B.c_str()+B.length());} \
 132 inline APT_PURE int name(const std::string& A,const char *B,const char *BEnd) {return func(A.c_str(),A.c_str()+A.length(),B,BEnd);}
 133
 134 #define APT_MKSTRCMP2(name,func) \
 135 inline APT_PURE int name(const char *A,const char *AEnd,const char *B) {return func(A,AEnd,B,B+strlen(B));} \
 136 inline APT_PURE int name(const std::string& A,const char *B) {return func(A.begin(),A.end(),B,B+strlen(B));} \
 137 inline APT_PURE int name(const std::string& A,const std::string& B) {return func(A.begin(),A.end(),B.begin(),B.end());} \
 138 inline APT_PURE int name(const std::string& A,const char *B,const char *BEnd) {return func(A.begin(),A.end(),B,BEnd);}
 139
 140 int APT_PURE stringcmp(const char *A,const char *AEnd,const char *B,const char *BEnd);
 141 int APT_PURE stringcasecmp(const char *A,const char *AEnd,const char *B,const char *BEnd);
 142
 143 /* We assume that GCC 3 indicates that libstdc++3 is in use too. In that
 144    case the definition of string::const_iterator is not the same as
 145    const char * and we need these extra functions */
 146 #if __GNUC__ >= 3
 147 int APT_PURE stringcmp(std::string::const_iterator A,std::string::const_iterator AEnd,
 148               const char *B,const char *BEnd);
 149 int APT_PURE stringcmp(std::string::const_iterator A,std::string::const_iterator AEnd,
 150               std::string::const_iterator B,std::string::const_iterator BEnd);
 151 int APT_PURE stringcasecmp(std::string::const_iterator A,std::string::const_iterator AEnd,
 152                   const char *B,const char *BEnd);
 153 int APT_PURE stringcasecmp(std::string::const_iterator A,std::string::const_iterator AEnd,
 154                   std::string::const_iterator B,std::string::const_iterator BEnd);
 155
 156 inline APT_PURE int stringcmp(std::string::const_iterator A,std::string::const_iterator Aend,const char *B) {return stringcmp(A,Aend,B,B+strlen(B));}
 157 inline APT_PURE int stringcasecmp(std::string::const_iterator A,std::string::const_iterator Aend,const char *B) {return stringcasecmp(A,Aend,B,B+strlen(B));}
 158 #endif
 159
 160 APT_MKSTRCMP2(stringcmp,stringcmp)
 161 APT_MKSTRCMP2(stringcasecmp,stringcasecmp)
 162
 163 // Return the length of a NULL-terminated string array
 164 size_t APT_PURE strv_length(const char **str_array);
 165
 166
 167 inline const char *DeNull(const char *s) {return (s == 0?"(null)":s);}
 168
 169 class URI
 170 {
 171    void CopyFrom(const std::string &From);
 172
 173    public:
 174
 175    std::string Access;
 176    std::string User;
 177    std::string Password;
 178    std::string Host;
 179    std::string Path;
 180    unsigned int Port;
 181
 182    operator std::string();
 183    inline void operator =(const std::string &From) {CopyFrom(From);}
 184    inline bool empty() {return Access.empty();};
 185    static std::string SiteOnly(const std::string &URI);
 186    static std::string ArchiveOnly(const std::string &URI);
 187    static std::string NoUserPassword(const std::string &URI);
 188
 189    URI(std::string Path) {CopyFrom(Path);}
 190    URI() : Port(0) {}
 191 };
 192
 193 struct SubstVar
 194 {
 195    const char *Subst;
 196    const std::string *Contents;
 197 };
 198 std::string SubstVar(std::string Str,const struct SubstVar *Vars);
 199 std::string SubstVar(const std::string &Str,const std::string &Subst,const std::string &Contents);
 200
 201 struct RxChoiceList
 202 {
 203    void *UserData;
 204    const char *Str;
 205    bool Hit;
 206 };
 207 unsigned long RegexChoice(RxChoiceList *Rxs,const char **ListBegin,
 208                       const char **ListEnd);
 209
 210 #endif