checkertypes.hpp

/*
* Copyright (C) 2017-2018, Kevin Brubeck Unhammer <unhammer@fsfe.org>
*
* This program 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.
*
* This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
*/
#pragma once
#ifndef ec895525de7e16bc_CHECKERTYPES_H
#define ec895525de7e16bc_CHECKERTYPES_H

#ifdef HAVE_CONFIG_H
#  include <config.h>
#endif

#include <string>
#include <set>
#include <unordered_map>
#include <regex>

namespace divvun {

/**
 * Public types for divvun-gramcheck library
 */

typedef std::string Lang;
typedef std::pair<std::u16string, std::u16string> Msg; // (<title>, <description>)
typedef std::u16string ErrId;
typedef std::basic_regex<char> ErrRe;

struct Err {
		std::u16string form;
		size_t beg;
		size_t end;
		ErrId err;
		Msg msg;
		std::vector<std::u16string> rep;
};

struct Option {
		std::string type;
		std::string name;
		std::unordered_map<ErrId, Msg> choices;      // choices[errtype] = msg;
};
struct OptionCompare {
    bool operator() (const Option& a, const Option& b) const {
        return a.name < b.name;
    }
};

/**
 * Radio-button choices (e.g. Oxford comma vs no-Oxford comma)
 */
typedef std::set<Option, OptionCompare> OptionSet;

/**
 * Checkbox choices, ie. hiding certain error types
 */
typedef std::unordered_map<ErrId, Msg> ToggleIds;      // toggleIds[errtype] = msg;
typedef std::vector<std::pair<ErrRe, Msg> > ToggleRes; // toggleRes = [(errtype_regex, msg), …];

struct Prefs {
		ToggleIds toggleIds;
		ToggleRes toggleRes;
		OptionSet options;
};
typedef std::unordered_map<Lang, Prefs> LocalisedPrefs;

} // namespace divvun

#endif