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
  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 using std::string;
  31 using std::vector;
  32 using std::ostream;
  33
  34 bool UTF8ToCodeset(const char *codeset, const string &orig, string *dest);
  35 char *_strstrip(char *String);
  36 char *_strtabexpand(char *String,size_t Len);
  37 bool ParseQuoteWord(const char *&String,string &Res);
  38 bool ParseCWord(const char *&String,string &Res);
  39 string QuoteString(const string &Str,const char *Bad);
  40 string DeQuoteString(const string &Str);
  41 string DeQuoteString(string::const_iterator const &begin, string::const_iterator const &end);
  42
  43 // unescape (\0XX and \xXX) from a string
  44 string DeEscapeString(const string &input);
  45
  46 string SizeToStr(double Bytes);
  47 string TimeToStr(unsigned long Sec);
  48 string Base64Encode(const string &Str);
  49 string OutputInDepth(const unsigned long Depth, const char* Separator="  ");
  50 string URItoFileName(const string &URI);
  51 string TimeRFC1123(time_t Date);
  52 bool RFC1123StrToTime(const char* const str,time_t &time) __must_check;
  53 bool FTPMDTMStrToTime(const char* const str,time_t &time) __must_check;
  54 __deprecated bool StrToTime(const string &Val,time_t &Result);
  55 string LookupTag(const string &Message,const char *Tag,const char *Default = 0);
  56 int StringToBool(const 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 StrToNum(const char *Str,unsigned long long &Res,unsigned Len,unsigned Base = 0);
  60 bool Base256ToNum(const char *Str,unsigned long &Res,unsigned int Len);
  61 bool Hex2Num(const string &Str,unsigned char *Num,unsigned int Length);
  62 bool TokSplitString(char Tok,char *Input,char **List,
  63                     unsigned long ListMax);
  64 vector<string> VectorizeString(string const &haystack, char const &split) __attrib_const;
  65 void ioprintf(ostream &out,const char *format,...) __like_printf(2);
  66 void strprintf(string &out,const char *format,...) __like_printf(2);
  67 char *safe_snprintf(char *Buffer,char *End,const char *Format,...) __like_printf(3);
  68 bool CheckDomainList(const string &Host, const string &List);
  69 int tolower_ascii(int const c) __attrib_const __hot;
  70 string StripEpoch(const string &VerStr);
  71
  72 #define APT_MKSTRCMP(name,func) \
  73 inline int name(const char *A,const char *B) {return func(A,A+strlen(A),B,B+strlen(B));}; \
  74 inline int name(const char *A,const char *AEnd,const char *B) {return func(A,AEnd,B,B+strlen(B));}; \
  75 inline int name(const string& A,const char *B) {return func(A.c_str(),A.c_str()+A.length(),B,B+strlen(B));}; \
  76 inline int name(const string& A,const string& B) {return func(A.c_str(),A.c_str()+A.length(),B.c_str(),B.c_str()+B.length());}; \
  77 inline int name(const string& A,const char *B,const char *BEnd) {return func(A.c_str(),A.c_str()+A.length(),B,BEnd);};
  78
  79 #define APT_MKSTRCMP2(name,func) \
  80 inline int name(const char *A,const char *AEnd,const char *B) {return func(A,AEnd,B,B+strlen(B));}; \
  81 inline int name(const string& A,const char *B) {return func(A.begin(),A.end(),B,B+strlen(B));}; \
  82 inline int name(const string& A,const string& B) {return func(A.begin(),A.end(),B.begin(),B.end());}; \
  83 inline int name(const string& A,const char *B,const char *BEnd) {return func(A.begin(),A.end(),B,BEnd);};
  84
  85 int stringcmp(const char *A,const char *AEnd,const char *B,const char *BEnd);
  86 int stringcasecmp(const char *A,const char *AEnd,const char *B,const char *BEnd);
  87
  88 /* We assume that GCC 3 indicates that libstdc++3 is in use too. In that
  89    case the definition of string::const_iterator is not the same as
  90    const char * and we need these extra functions */
  91 #if __GNUC__ >= 3
  92 int stringcmp(string::const_iterator A,string::const_iterator AEnd,
  93               const char *B,const char *BEnd);
  94 int stringcmp(string::const_iterator A,string::const_iterator AEnd,
  95               string::const_iterator B,string::const_iterator BEnd);
  96 int stringcasecmp(string::const_iterator A,string::const_iterator AEnd,
  97                   const char *B,const char *BEnd);
  98 int stringcasecmp(string::const_iterator A,string::const_iterator AEnd,
  99                   string::const_iterator B,string::const_iterator BEnd);
 100
 101 inline int stringcmp(string::const_iterator A,string::const_iterator Aend,const char *B) {return stringcmp(A,Aend,B,B+strlen(B));};
 102 inline int stringcasecmp(string::const_iterator A,string::const_iterator Aend,const char *B) {return stringcasecmp(A,Aend,B,B+strlen(B));};
 103 #endif
 104
 105 APT_MKSTRCMP2(stringcmp,stringcmp);
 106 APT_MKSTRCMP2(stringcasecmp,stringcasecmp);
 107
 108 inline const char *DeNull(const char *s) {return (s == 0?"(null)":s);};
 109
 110 class URI
 111 {
 112    void CopyFrom(const string &From);
 113
 114    public:
 115
 116    string Access;
 117    string User;
 118    string Password;
 119    string Host;
 120    string Path;
 121    unsigned int Port;
 122
 123    operator string();
 124    inline void operator =(const string &From) {CopyFrom(From);};
 125    inline bool empty() {return Access.empty();};
 126    static string SiteOnly(const string &URI);
 127    static string NoUserPassword(const string &URI);
 128
 129    URI(string Path) {CopyFrom(Path);};
 130    URI() : Port(0) {};
 131 };
 132
 133 struct SubstVar
 134 {
 135    const char *Subst;
 136    const string *Contents;
 137 };
 138 string SubstVar(string Str,const struct SubstVar *Vars);
 139 string SubstVar(const string &Str,const string &Subst,const string &Contents);
 140
 141 struct RxChoiceList
 142 {
 143    void *UserData;
 144    const char *Str;
 145    bool Hit;
 146 };
 147 unsigned long RegexChoice(RxChoiceList *Rxs,const char **ListBegin,
 148                       const char **ListEnd);
 149
 150 #endif