- initial import of revision 374 from cnc
[apt.git] / 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 char *_strstrip(char *String);
43 char *_strtabexpand(char *String,size_t Len);
44 bool ParseQuoteWord(const char *&String,string &Res);
45 bool ParseCWord(const char *&String,string &Res);
46 string QuoteString(string Str,const char *Bad);
47 string DeQuoteString(string Str);
48 string SizeToStr(double Bytes);
49 string TimeToStr(unsigned long Sec);
50 string Base64Encode(string Str);
51 string URItoFileName(string URI);
52 string TimeRFC1123(time_t Date);
53 bool StrToTime(string Val,time_t &Result);
54 string LookupTag(string Message,const char *Tag,const char *Default = 0);
55 int StringToBool(string Text,int Default = -1);
56 bool ReadMessages(int Fd, vector<string> &List);
57 bool StrToNum(const char *Str,unsigned long &Res,unsigned Len,unsigned Base = 0);
58 bool Hex2Num(string Str,unsigned char *Num,unsigned int Length);
59 bool TokSplitString(char Tok,char *Input,char **List,
60                     unsigned long ListMax);
61 void ioprintf(ostream &out,const char *format,...) APT_FORMAT2;
62 char *safe_snprintf(char *Buffer,char *End,const char *Format,...) APT_FORMAT3;
63 bool CheckDomainList(string Host,string List);
64
65 #define APT_MKSTRCMP(name,func) \
66 inline int name(const char *A,const char *AEnd,const char *B) {return func(A,AEnd,B,B+strlen(B));}; \
67 inline int name(string A,const char *B) {return func(A.c_str(),A.c_str()+A.length(),B,B+strlen(B));}; \
68 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());}; \
69 inline int name(string A,const char *B,const char *BEnd) {return func(A.c_str(),A.c_str()+A.length(),B,BEnd);}; 
70
71 #define APT_MKSTRCMP2(name,func) \
72 inline int name(const char *A,const char *AEnd,const char *B) {return func(A,AEnd,B,B+strlen(B));}; \
73 inline int name(string A,const char *B) {return func(A.begin(),A.end(),B,B+strlen(B));}; \
74 inline int name(string A,string B) {return func(A.begin(),A.end(),B.begin(),B.end());}; \
75 inline int name(string A,const char *B,const char *BEnd) {return func(A.begin(),A.end(),B,BEnd);}; 
76
77 int stringcmp(const char *A,const char *AEnd,const char *B,const char *BEnd);
78 int stringcasecmp(const char *A,const char *AEnd,const char *B,const char *BEnd);
79
80 /* We assume that GCC 3 indicates that libstdc++3 is in use too. In that
81    case the definition of string::const_iterator is not the same as
82    const char * and we need these extra functions */
83 #if __GNUC__ >= 3
84 int stringcmp(string::const_iterator A,string::const_iterator AEnd,
85               const char *B,const char *BEnd);
86 int stringcmp(string::const_iterator A,string::const_iterator AEnd,
87               string::const_iterator B,string::const_iterator BEnd);
88 int stringcasecmp(string::const_iterator A,string::const_iterator AEnd,
89                   const char *B,const char *BEnd);
90 int stringcasecmp(string::const_iterator A,string::const_iterator AEnd,
91                   string::const_iterator B,string::const_iterator BEnd);
92
93 inline int stringcmp(string::const_iterator A,string::const_iterator Aend,const char *B) {return stringcmp(A,Aend,B,B+strlen(B));};
94 inline int stringcasecmp(string::const_iterator A,string::const_iterator Aend,const char *B) {return stringcasecmp(A,Aend,B,B+strlen(B));};
95 #endif
96
97 APT_MKSTRCMP2(stringcmp,stringcmp);
98 APT_MKSTRCMP2(stringcasecmp,stringcasecmp);
99
100 inline const char *DeNull(const char *s) {return (s == 0?"(null)":s);};
101
102 class URI
103 {
104    void CopyFrom(string From);
105                  
106    public:
107    
108    string Access;
109    string User;
110    string Password;
111    string Host;
112    string Path;
113    unsigned int Port;
114    
115    operator string();
116    inline void operator =(string From) {CopyFrom(From);};
117    inline bool empty() {return Access.empty();};
118    static string SiteOnly(string URI);
119    
120    URI(string Path) {CopyFrom(Path);};
121    URI() : Port(0) {};
122 };
123
124 struct SubstVar
125 {
126    const char *Subst;
127    const string *Contents;
128 };
129 string SubstVar(string Str,const struct SubstVar *Vars);
130 string SubstVar(string Str,string Subst,string Contents);
131
132 struct RxChoiceList
133 {
134    void *UserData;
135    const char *Str;
136    bool Hit;
137 };
138 unsigned long RegexChoice(RxChoiceList *Rxs,const char **ListBegin,
139                       const char **ListEnd);
140
141 #undef APT_FORMAT2
142
143 #endif