Page MenuHomePhabricator (Chris)
Files F627612

WordWrapper.h
No OneTemporary
Actions

Authored By
Unknown
Size
3 KB
Referenced Files
None
Subscribers
None

WordWrapper.h
View Options

/*
* Copyright (C) 2019 Me and My Shadow
*
* This file is part of Me and My Shadow.
*
* Me and My Shadow 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.
*
* Me and My Shadow 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 Me and My Shadow. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef WORDWRAPPER_H
#define WORDWRAPPER_H
#include <vector>
#include <string>
#include <set>
// The forward declaration of TTF_Font is clunky
struct _TTF_Font;
typedef struct _TTF_Font TTF_Font;
// The custom callback for word wrapper.
class WordWrapperCallback {
public:
WordWrapperCallback();
virtual ~WordWrapperCallback();
// This function is called before a new line is added.
virtual void newLine() = 0;
// Check if a character is a breakable space.
// This function is called for every character exactly once, so you can return different values according to previously read characters.
virtual bool isBreakableSpace(int ch) = 0;
// This function is called when a new word is read. The word can be modified.
// The return value is the new width of this word. If >0 then the hyphenation is disabled.
virtual int processWord(std::string& spaces, std::string& nonSpaces) = 0;
};
class WordWrapper {
public:
// The font.
TTF_Font *font;
// The maximal width (in pixels if font is not NULL, in characters if font is NULL)
int maxWidth;
// The hyphen used for the hyphenator. If it's empty, the hyphenator is disabled.
std::string hyphen;
// Enable word wrapping.
// NOTE: If word wrapping is disabled, the callback is ignored at all.
bool wordWrap;
// Don't hyphenate the words containing http:// or https://.
bool reserveHyperlinks;
// Don't hyphenate the following reserved words (case sensitive).
std::set<std::string> reservedWords;
// Don't hyphenate the words if it contains the following fragments (case sensitive).
std::set<std::string> reservedFragments;
// The language used for the hyphenator.
// "" means use current language.
std::string hyphenatorLanguage;
// The custom callback object.
WordWrapperCallback *callback;
private:
// Calculate text width (in pixels if font is not NULL, in characters if font is NULL).
int getTextWidth(const std::string& s);
// Calculate glyph width (in pixels if font is not NULL, in characters if font is NULL).
int getGlyphWidth(int ch);
// Check if a word is reserved.
bool isReserved(const std::string& word);
// Internal function.
int addWord(std::vector<std::string>& output, std::string& line, int& lineWidth, std::string& spaces, std::string& nonSpaces);
public:
WordWrapper();
~WordWrapper();
// Add a string (possible multiline) to output.
// Returns the maximal width required for this string.
int addString(std::vector<std::string>& output, const std::string& input);
// Add a single line string (subject to wordwrap) to output.
// Returns the maximal width required for this string.
int addLine(std::vector<std::string>& output, const std::string& input);
// Add a list of lines (assume each line is a single line string, subject to wordwrap) to output.
// Returns the maximal width required for this string.
int addLines(std::vector<std::string>& output, const std::vector<std::string>& input);
};
#endif

File Metadata

Mime Type
text/x-c++
Expires
Sun, Nov 15, 2:24 AM (1 d, 23 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
141086
Default Alt Text
WordWrapper.h (3 KB)

Event Timeline