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 (\0XXX and \xXX) from a string
  44 string DeEscapeString(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 Base256ToNum(const char *Str,unsigned long &Res,unsigned int Len);
  60 bool Hex2Num(const string &Str,unsigned char *Num,unsigned int Length);
  61 bool TokSplitString(char Tok,char *Input,char **List,
  62                     unsigned long ListMax);
  63 vector<string> VectorizeString(string const &haystack, char const &split) __attrib_const;
  64 void ioprintf(ostream &out,const char *format,...) __like_printf(2);
  65 void strprintf(string &out,const char *format,...) __like_printf(2);
  66 char *safe_snprintf(char *Buffer,char *End,const char *Format,...) __like_printf(3);
  67 bool CheckDomainList(const string &Host, const string &List);
  68 int tolower_ascii(int const c) __attrib_const __hot;
  69 string StripEpoch(const string &VerStr);
  70
  71 #define APT_MKSTRCMP(name,func) \
  72 inline int name(const char *A,const char *B) {return func(A,A+strlen(A),B,B+strlen(B));}; \
  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(const string& A,const char *B) {return func(A.c_str(),A.c_str()+A.length(),B,B+strlen(B));}; \
  75 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());}; \
  76 inline int name(const string& A,const char *B,const char *BEnd) {return func(A.c_str(),A.c_str()+A.length(),B,BEnd);};
  77
  78 #define APT_MKSTRCMP2(name,func) \
  79 inline int name(const char *A,const char *AEnd,const char *B) {return func(A,AEnd,B,B+strlen(B));}; \
  80 inline int name(const string& A,const char *B) {return func(A.begin(),A.end(),B,B+strlen(B));}; \
  81 inline int name(const string& A,const string& B) {return func(A.begin(),A.end(),B.begin(),B.end());}; \
  82 inline int name(const string& A,const char *B,const char *BEnd) {return func(A.begin(),A.end(),B,BEnd);};
  83
  84 int stringcmp(const char *A,const char *AEnd,const char *B,const char *BEnd);
  85 int stringcasecmp(const char *A,const char *AEnd,const char *B,const char *BEnd);
  86
  87 /* We assume that GCC 3 indicates that libstdc++3 is in use too. In that
  88    case the definition of string::const_iterator is not the same as
  89    const char * and we need these extra functions */
  90 #if __GNUC__ >= 3
  91 int stringcmp(string::const_iterator A,string::const_iterator AEnd,
  92               const char *B,const char *BEnd);
  93 int stringcmp(string::const_iterator A,string::const_iterator AEnd,
  94               string::const_iterator B,string::const_iterator BEnd);
  95 int stringcasecmp(string::const_iterator A,string::const_iterator AEnd,
  96                   const char *B,const char *BEnd);
  97 int stringcasecmp(string::const_iterator A,string::const_iterator AEnd,
  98                   string::const_iterator B,string::const_iterator BEnd);
  99
 100 inline int stringcmp(string::const_iterator A,string::const_iterator Aend,const char *B) {return stringcmp(A,Aend,B,B+strlen(B));};
 101 inline int stringcasecmp(string::const_iterator A,string::const_iterator Aend,const char *B) {return stringcasecmp(A,Aend,B,B+strlen(B));};
 102 #endif
 103
 104 APT_MKSTRCMP2(stringcmp,stringcmp);
 105 APT_MKSTRCMP2(stringcasecmp,stringcasecmp);
 106
 107 inline const char *DeNull(const char *s) {return (s == 0?"(null)":s);};
 108
 109 class URI
 110 {
 111    void CopyFrom(const string &From);
 112
 113    public:
 114
 115    string Access;
 116    string User;
 117    string Password;
 118    string Host;
 119    string Path;
 120    unsigned int Port;
 121
 122    operator string();
 123    inline void operator =(const string &From) {CopyFrom(From);};
 124    inline bool empty() {return Access.empty();};
 125    static string SiteOnly(const string &URI);
 126    static string NoUserPassword(const string &URI);
 127
 128    URI(string Path) {CopyFrom(Path);};
 129    URI() : Port(0) {};
 130 };
 131
 132 struct SubstVar
 133 {
 134    const char *Subst;
 135    const string *Contents;
 136 };
 137 string SubstVar(string Str,const struct SubstVar *Vars);
 138 string SubstVar(const string &Str,const string &Subst,const string &Contents);
 139
 140 struct RxChoiceList
 141 {
 142    void *UserData;
 143    const char *Str;
 144    bool Hit;
 145 };
 146 unsigned long RegexChoice(RxChoiceList *Rxs,const char **ListBegin,
 147                       const char **ListEnd);
 148
 149 #endif