escapismC Class Reference

Inheritance diagram for escapismC:

Collaboration diagram for escapismC:

Private Member Functions
void	escape (const std::string &unEscaped, std::string &escaped) const override
void	deEscape (const std::string &escaped, std::string &unEscaped) const override

Static Private Member Functions
static const std::map< char, char > &	getEscapeMap ()
static const std::map< char, char >	invertEscapeMap ()
static const std::map< char, char > &	getUnEscapeMap ()
static charCodingBitPatternType	initCodeList ()
static bool	unencoded (char c)

Static Private Attributes
static escapismFactoryClassTemplate< escapismC >	factory

Additional Inherited Members
Static Public Member Functions inherited from escapism
static const escapism *	newEscaper (const std::string &name)
static void	addAllowedNamesToOption (options::single< std::string > &option)
static options::single< std::string > *	newEscaperOption (const std::string &name, const std::string &description, const std::string &defaultValue="Url")

Detailed Description

Definition at line 137 of file escapism.cpp.

Member Function Documentation

deEscape()

void escapismC::deEscape ( const std::string &  escaped, std::string &  unEscaped  ) const

inlineoverrideprivatevirtual

Implements escapism.

Definition at line 196 of file escapism.cpp.

                                                                                 {
        unEscaped.reserve(escaped.size()); // de-Escaped is always smaller, so this always fits and saves time
        std::remove_reference<decltype(unEscaped)>::type::value_type code;
        enum {normal, escaping, second3bits, last3bits} state = normal;
        for (auto c : escaped) {
            if (state == normal) {
                if (c == '\\') {
                    state = escaping;
                    continue;
                }
                unEscaped.push_back(c);
            } else if (state == escaping) {
                auto enc = getUnEscapeMap().find(c);
                if (enc != getUnEscapeMap().end()) {
                    unEscaped.push_back(enc->second);
                    state = normal;
                    continue;
                }
                if ('0' <= c && c <= '7') {
                    decltype(code) threeBits;
                    threeBits = c - '0';
                    code = threeBits << 6;
                    state = second3bits;
                    continue;
                } else {
                    throw std::invalid_argument("bad encoding");
                }
            } else if (state == second3bits) {
                if ('0' <= c && c <= '7') {
                    decltype(code) threeBits;
                    threeBits = c - '0';
                    code |= threeBits << 3;
                    state = last3bits;
                    continue;
                } else {
                    throw std::invalid_argument("bad encoding");
                }
            } else if (state == last3bits) {
                if ('0' <= c && c <= '7') {
                    decltype(code) threeBits;
                    threeBits = c - '0';
                    code |= threeBits << 0;
                    unEscaped.push_back(code);
                    state = normal;
                    continue;
                } else {
                    throw std::invalid_argument("bad encoding");
                }
            }
        }
 
        if (state != normal) {
            throw std::invalid_argument("bad encoding");
        }
    }

References getUnEscapeMap().

Here is the call graph for this function:

escape()

void escapismC::escape ( const std::string &  unEscaped, std::string &  escaped  ) const

inlineoverrideprivatevirtual

Implements escapism.

Definition at line 179 of file escapism.cpp.

                                                                               {
        for (auto c : unEscaped) {
            if (unencoded(c)) {
                escaped.push_back(c);
            } else {
                escaped.push_back('\\');
                auto enc = getEscapeMap().find(c);
                if (enc != getEscapeMap().end()) {
                    escaped.push_back(enc->second);
                } else {
                    escaped.push_back('0' + ((c >> 6) & 0x07));
                    escaped.push_back('0' + ((c >> 3) & 0x07));
                    escaped.push_back('0' + ((c >> 0) & 0x07));
                }
            }
        }
    }

References getEscapeMap(), and unencoded().

Here is the call graph for this function:

getEscapeMap()

static const std::map<char, char>& escapismC::getEscapeMap ( )

inlinestaticprivate

Definition at line 139 of file escapism.cpp.

                                                    {
        static std::remove_reference<decltype(getEscapeMap())>::type escapeMap{
            {'\a', 'a'},
            {'\b', 'b'},
            {'\f', 'f'},
            {'\n', 'n'},
            {'\r', 'r'},
            {'\v', 'v'},
            {'\\', '\\'},
            {' ', ' '},
            {'\'', '\''},
            {'"', '"'},
        };
        return escapeMap;
    }

Referenced by escape(), initCodeList(), and invertEscapeMap().

Here is the caller graph for this function:

getUnEscapeMap()

static const std::map<char, char>& escapismC::getUnEscapeMap ( )

inlinestaticprivate

Definition at line 161 of file escapism.cpp.

                                                      {
        static std::remove_reference<decltype(getUnEscapeMap())>::type unEscapeMap(invertEscapeMap());
        return unEscapeMap;
    }

References invertEscapeMap().

Referenced by deEscape().

Here is the call graph for this function:

Here is the caller graph for this function:

initCodeList()

static charCodingBitPatternType escapismC::initCodeList ( )

inlinestaticprivate

Definition at line 166 of file escapism.cpp.

                                                   {
        charCodingBitPatternType codingPattern = {{0ull, 0ull, 0ull, 0ull}};
        for (char c = ' '; c < 127; c++) {
            if (getEscapeMap().find(c) == getEscapeMap().end()) {
                codingPattern.bits[charCodingBitPatternType::index(c)] |= charCodingBitPatternType::mask(c);
            }
        }
        return codingPattern;
    }

References escapism::charCodingBitPatternType::bits, getEscapeMap(), escapism::charCodingBitPatternType::index(), and escapism::charCodingBitPatternType::mask().

Referenced by unencoded().

Here is the call graph for this function:

Here is the caller graph for this function:

invertEscapeMap()

static const std::map<char, char> escapismC::invertEscapeMap ( )

inlinestaticprivate

Definition at line 154 of file escapism.cpp.

                                                      {
        std::map<char, char> map;
        for (const auto& item : getEscapeMap()) {
            map.emplace(item.second, item.first);
        }
        return map;
    }

References getEscapeMap().

Referenced by getUnEscapeMap().

Here is the call graph for this function:

Here is the caller graph for this function:

unencoded()

static bool escapismC::unencoded ( char  c )

inlinestaticprivate

Definition at line 175 of file escapism.cpp.

                                  {
        static charCodingBitPatternType codingPattern = initCodeList();
        return (codingPattern.bits[charCodingBitPatternType::index(c)] & charCodingBitPatternType::mask(c)) != 0ull;
    }

References escapism::charCodingBitPatternType::bits, escapism::charCodingBitPatternType::index(), initCodeList(), and escapism::charCodingBitPatternType::mask().

Referenced by escape().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

factory

escapismFactoryClassTemplate<escapismC> escapismC::factory

staticprivate

Definition at line 138 of file escapism.cpp.

---

The documentation for this class was generated from the following file:

• src/escapism.cpp (v0.19-24-g0617ca1 with changes)