pmstring.h

Go to the documentation of this file.

/*!\file pmstring.h
        \brief Declerations for PackageManager String class.
        Part of the heart of the PackageManager.*/

#ifndef __PMSTRING_H__
#define __PMSTRING_H__

#include <string>
#include <vector>

//!The Package Manger string class.
/*!Simple inherited class to inherit from std::string. Includes
  some string manipulation functions useful to the package manager.*/
class PMString : public std::string
{
        public:
                PMString() : std::string(){}                                                                                                                                                    //!<Inherits from std::string.
                PMString(const char *ptr) : std::string(ptr) {}                                                                                                                 //!<Inherits from std::string.
                PMString(const std::string& s) : std::string(s) {}                                                                                                              //!<Inherits from std::string.
                PMString(size_type length, const char& ch) : std::string( length, ch) {}                                                                //!<Inherits from std::string.
                PMString(const char* str, size_type length) : std::string(str,length) {}                                                                //!<Inherits from std::string.
                PMString(const std::string& str, size_type index, size_type length) : std::string(str,index,length) {}  //!<Inherits from std::string.
                
                std::vector<PMString> Split(char const* delims = " \t\r\n");                    //!<Split the string around delims and return a vector of the split. Delims defaults to whitespace.
                std::vector<PMString> ProcessUseFlags(std::vector<PMString> useFlags);  //!<Removes atoms not associated with useflags provided.
                
                PMString GetName();                     //!<Returns the name when string is in cat/name-version format.
                PMString GetCategory();         //!<Returns the category when string is in cat/name-version format.
                PMString GetVersion();          //!<Returns the version when string is in cat/name-version format.
                PMString GetFileName();         //!<Returns the filename if string is in the form dir/dir/filename.
                
                void TrimWhitespace();                                          //!<Remove the whitespace from either end of the string.
                void FormatSize(int size);                                      //!<Format the string as a size - should only be called if the string only contains numbers.
                int VersionCompare(PMString secondVersion);     //!<Compare this string with secondVersion string.
                bool StartsWith(PMString secondString);         //!<True if this starts with secondString.
                
        protected:
                std::vector<PMString>::iterator _BypassBrackets(std::vector<PMString>::iterator currentLocation,std::vector<PMString>::iterator endLocation);   //!<Go out of scope of the current bracket.
};

#endif

---