root/msg/lexutils.hh

/*  This file is part of Alue, the multiprotocol Internet discussion daemon

    Copyright © 2009, 2010 Antti-Juhani Kaijanaho

    Alue is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Alue is distributed in the hope that it will be useful, but
    WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with Alue.  If not, see <http://www.gnu.org/licenses/>.

 */

#ifndef GUARD_MSG_LEXUTILS_HH
#define GUARD_MSG_LEXUTILS_HH

#include <list>
#include <string>

namespace msg
{
        bool is_atext(char c);
        void skip_cfws(std::string &);
        std::string get_atom(std::string &str, bool decode = true, std::string extra_delimeters="");
        std::string get_word(std::string &, bool decode = true);
        std::string decode_unstructured(std::string);

        // if there is no message id at the beginning of the string,
        // returns a null string and shortens the argument string by
        // an unspecified amount (by erasing an initial substring)
        std::string get_msgid(std::string &);

        std::list<std::string> parse_newsgroups_list(std::string ngline);

        std::string make_phrase(std::string, bool encode = true);

        std::string encode_unstructured(std::string);

        // note: this assumes that any CR or LF is folding whitespace!
        // (ie. don't use this for validation, or if you don't have
        // the field boundary already marked)
        inline bool is_fwsp(char c)
        {
                return c == ' ' || c == '\t' || c == '\r' || c == '\n';
        }

        bool eat_literal(std::string &, std::string literal,
                         bool case_sensitive = true);
}

#endif /* GUARD_MSG_LEXUTILS_HH */