CRNTextFile.h

Go to the documentation of this file.

/* Copyright 2006-2016 Yann LEYDIER, CoReNum, INSA-Lyon, ENS-Lyon
 * 
 * This file is part of libcrn.
 * 
 * libcrn is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * libcrn 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 Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with libcrn.  If not, see <http://www.gnu.org/licenses/>.
 * 
 * file: CRNTextFile.h
 * \author Yann LEYDIER
 */

#ifndef CRNTEXTFILE_HEADER
#define CRNTEXTFILE_HEADER

#include <CRNString.h>
#include <CRNIO/CRNPath.h>
#include <vector>
#include <set>
#include <map>

namespace crn
{
    /****************************************************************************/
    class TextFile
    {
        public:
            enum class Encoding { UTF_8, UTF_32 };

            TextFile(Encoding enc = Encoding::UTF_8);
            TextFile(const Path &fname, Encoding enc = Encoding::UTF_8);
            TextFile(const TextFile&) = delete;
            TextFile(TextFile&&) = default;
            ~TextFile() = default;

            TextFile& operator=(const TextFile&) = delete;
            TextFile& operator=(TextFile&&) = default;

            void Save(const Path &fname);
            void Save(const Path &fname, Encoding enc);
            void Save();
            
            const String& GetText() const noexcept {return text;};

            std::vector<String> SplitText() const { return text.Split(U" \r\n\t,.!?:;&\"\'({[|`_\\^@)]}=+^$£%*/<>-"); }
            std::set<String> ExtractWords(bool case_sensitive = false) const;
            std::map<int, String> ExtractWordsByFrequency(bool case_sensitive = false) const;

            String text; 
        private:
            Path filename;  
            Encoding original_encoding; 
    };

    CRN_ALIAS_SMART_PTR(TextFile)
}


#endif