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