// -*- mode: cpp; mode: fold -*- // Description /*{{{*/ // $Id: strutl.h,v 1.22 2003/02/02 22:20:27 jgg Exp $ /* ###################################################################### String Util - These are some useful string functions _strstrip is a function to remove whitespace from the front and end of a string. This source is placed in the Public Domain, do with it what you will It was originally written by Jason Gunthorpe <jgg@gpu.srv.ualberta.ca> ##################################################################### */ /*}}}*/ #ifndef STRUTL_H #define STRUTL_H #include <cstring> #include <iostream> #include <limits> #include <string> #include <vector> #ifdef APT_PKG_EXPOSE_STRING_VIEW #include <apt-pkg/string_view.h> #endif #include <stddef.h> #include <time.h> #include "macros.h" #ifndef APT_10_CLEANER_HEADERS #include <stdlib.h> #endif #ifndef APT_8_CLEANER_HEADERS using std::string; using std::vector; using std::ostream; #endif namespace APT { namespace String { std::string Strip(const std::string &s); bool Endswith(const std::string &s, const std::string &ending); bool Startswith(const std::string &s, const std::string &starting); std::string Join(std::vector<std::string> list, const std::string &sep); } } bool UTF8ToCodeset(const char *codeset, const std::string &orig, std::string *dest); char *_strstrip(char *String); char *_strrstrip(char *String); // right strip only char *_strtabexpand(char *String,size_t Len); bool ParseQuoteWord(const char *&String,std::string &Res); bool ParseCWord(const char *&String,std::string &Res); std::string QuoteString(const std::string &Str,const char *Bad); std::string DeQuoteString(const std::string &Str); std::string DeQuoteString(std::string::const_iterator const &begin, std::string::const_iterator const &end); // unescape (\0XX and \xXX) from a string std::string DeEscapeString(const std::string &input); std::string SizeToStr(double Bytes); std::string TimeToStr(unsigned long Sec); std::string Base64Encode(const std::string &Str); std::string OutputInDepth(const unsigned long Depth, const char* Separator=" "); std::string URItoFileName(const std::string &URI); APT_DEPRECATED_MSG("Specify if GMT is required or a numeric timezone can be used") std::string TimeRFC1123(time_t Date); /** returns a datetime string as needed by HTTP/1.1 and Debian files. * * Note: The date will always be represented in a UTC timezone * * @param Date to be represented as a string * @param NumericTimezone is preferred in general, but HTTP/1.1 requires the use * of GMT as timezone instead. \b true means that the timezone should be denoted * as "+0000" while \b false uses "GMT". */ std::string TimeRFC1123(time_t Date, bool const NumericTimezone); /** parses time as needed by HTTP/1.1 and Debian files. * * HTTP/1.1 prefers dates in RFC1123 format (but the other two obsolete date formats * are supported to) and e.g. Release files use the same format in Date & Valid-Until * fields. * * Note: datetime strings need to be in UTC timezones (GMT, UTC, Z, +/-0000) to be * parsed. Other timezones will be rejected as invalid. Previous implementations * accepted other timezones, but treated them as UTC. * * @param str is the datetime string to parse * @param[out] time will be the seconds since epoch of the given datetime if * parsing is successful, undefined otherwise. * @return \b true if parsing was successful, otherwise \b false. */ bool RFC1123StrToTime(const char* const str,time_t &time) APT_MUSTCHECK; bool FTPMDTMStrToTime(const char* const str,time_t &time) APT_MUSTCHECK; APT_DEPRECATED_MSG("Use RFC1123StrToTime or FTPMDTMStrToTime as needed instead") bool StrToTime(const std::string &Val,time_t &Result); std::string LookupTag(const std::string &Message,const char *Tag,const char *Default = 0); int StringToBool(const std::string &Text,int Default = -1); bool ReadMessages(int Fd, std::vector<std::string> &List); bool StrToNum(const char *Str,unsigned long &Res,unsigned Len,unsigned Base = 0); bool StrToNum(const char *Str,unsigned long long &Res,unsigned Len,unsigned Base = 0); bool Base256ToNum(const char *Str,unsigned long &Res,unsigned int Len); bool Base256ToNum(const char *Str,unsigned long long &Res,unsigned int Len); bool Hex2Num(const std::string &Str,unsigned char *Num,unsigned int Length); #ifdef APT_PKG_EXPOSE_STRING_VIEW APT_HIDDEN bool Hex2Num(const APT::StringView Str,unsigned char *Num,unsigned int Length); #endif // input changing string split bool TokSplitString(char Tok,char *Input,char **List, unsigned long ListMax); // split a given string by a char std::vector<std::string> VectorizeString(std::string const &haystack, char const &split) APT_PURE; /* \brief Return a vector of strings from string "input" where "sep" * is used as the delimiter string. * * \param input The input string. * * \param sep The separator to use. * * \param maxsplit (optional) The maximum amount of splitting that * should be done . * * The optional "maxsplit" argument can be used to limit the splitting, * if used the string is only split on maxsplit places and the last * item in the vector contains the remainder string. */ std::vector<std::string> StringSplit(std::string const &input, std::string const &sep, unsigned int maxsplit=std::numeric_limits<unsigned int>::max()) APT_PURE; void ioprintf(std::ostream &out,const char *format,...) APT_PRINTF(2); void strprintf(std::string &out,const char *format,...) APT_PRINTF(2); char *safe_snprintf(char *Buffer,char *End,const char *Format,...) APT_PRINTF(3); bool CheckDomainList(const std::string &Host, const std::string &List); /* Do some compat mumbo jumbo */ #define tolower_ascii tolower_ascii_inline #define isspace_ascii isspace_ascii_inline APT_PURE APT_HOT static inline int tolower_ascii_unsafe(int const c) { return c | 0x20; } APT_PURE APT_HOT static inline int tolower_ascii_inline(int const c) { return (c >= 'A' && c <= 'Z') ? c + 32 : c; } APT_PURE APT_HOT static inline int isspace_ascii_inline(int const c) { // 9='\t',10='\n',11='\v',12='\f',13='\r',32=' ' return (c >= 9 && c <= 13) || c == ' '; } std::string StripEpoch(const std::string &VerStr); #define APT_MKSTRCMP(name,func) \ inline APT_PURE int name(const char *A,const char *B) {return func(A,A+strlen(A),B,B+strlen(B));} \ inline APT_PURE int name(const char *A,const char *AEnd,const char *B) {return func(A,AEnd,B,B+strlen(B));} \ inline APT_PURE int name(const std::string& A,const char *B) {return func(A.c_str(),A.c_str()+A.length(),B,B+strlen(B));} \ inline APT_PURE 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());} \ inline APT_PURE int name(const std::string& A,const char *B,const char *BEnd) {return func(A.c_str(),A.c_str()+A.length(),B,BEnd);} #define APT_MKSTRCMP2(name,func) \ inline APT_PURE int name(const char *A,const char *AEnd,const char *B) {return func(A,AEnd,B,B+strlen(B));} \ inline APT_PURE int name(const std::string& A,const char *B) {return func(A.begin(),A.end(),B,B+strlen(B));} \ inline APT_PURE int name(const std::string& A,const std::string& B) {return func(A.begin(),A.end(),B.begin(),B.end());} \ inline APT_PURE int name(const std::string& A,const char *B,const char *BEnd) {return func(A.begin(),A.end(),B,BEnd);} int APT_PURE stringcmp(const char *A,const char *AEnd,const char *B,const char *BEnd); int APT_PURE stringcasecmp(const char *A,const char *AEnd,const char *B,const char *BEnd); /* We assume that GCC 3 indicates that libstdc++3 is in use too. In that case the definition of string::const_iterator is not the same as const char * and we need these extra functions */ #if __GNUC__ >= 3 int APT_PURE stringcmp(std::string::const_iterator A,std::string::const_iterator AEnd, const char *B,const char *BEnd); int APT_PURE stringcmp(std::string::const_iterator A,std::string::const_iterator AEnd, std::string::const_iterator B,std::string::const_iterator BEnd); int APT_PURE stringcasecmp(std::string::const_iterator A,std::string::const_iterator AEnd, const char *B,const char *BEnd); int APT_PURE stringcasecmp(std::string::const_iterator A,std::string::const_iterator AEnd, std::string::const_iterator B,std::string::const_iterator BEnd); inline APT_PURE int stringcmp(std::string::const_iterator A,std::string::const_iterator Aend,const char *B) {return stringcmp(A,Aend,B,B+strlen(B));} inline APT_PURE int stringcasecmp(std::string::const_iterator A,std::string::const_iterator Aend,const char *B) {return stringcasecmp(A,Aend,B,B+strlen(B));} #endif APT_MKSTRCMP2(stringcmp,stringcmp) APT_MKSTRCMP2(stringcasecmp,stringcasecmp) // Return the length of a NULL-terminated string array size_t APT_PURE strv_length(const char **str_array); inline const char *DeNull(const char *s) {return (s == 0?"(null)":s);} class URI { void CopyFrom(const std::string &From); public: std::string Access; std::string User; std::string Password; std::string Host; std::string Path; unsigned int Port; operator std::string(); inline void operator =(const std::string &From) {CopyFrom(From);} inline bool empty() {return Access.empty();}; static std::string SiteOnly(const std::string &URI); static std::string ArchiveOnly(const std::string &URI); static std::string NoUserPassword(const std::string &URI); URI(std::string Path) {CopyFrom(Path);} URI() : Port(0) {} }; struct SubstVar { const char *Subst; const std::string *Contents; }; std::string SubstVar(std::string Str,const struct SubstVar *Vars); std::string SubstVar(const std::string &Str,const std::string &Subst,const std::string &Contents); struct RxChoiceList { void *UserData; const char *Str; bool Hit; }; unsigned long RegexChoice(RxChoiceList *Rxs,const char **ListBegin, const char **ListEnd); #endif