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