dallasgroot/0ad
1
0
Fork 0
mirror of https://gitea.wildfiregames.com/0ad/0ad synced 2026-06-16 05:13:58 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Split CGUIString.h from GUIText.h, so that one may have the SGUIText implementation in a separate cpp file.

Browse source 
Differential Revision: https://code.wildfiregames.com/D2167
Reviewed By: Vladislav
Tested on: gcc 9.0.1, VS2015, Jenkins

This was SVN commit r22643.
This commit is contained in:
elexis 2019-08-10 19:16:52 +00:00
parent d3e56f0f57
commit 838889ab12
5 changed files with 233 additions and 205 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
source/gui/CChart.cpp
View file

@ -20,6 +20,7 @@
#include "CChart.h"
#include "gui/CGUIColor.h"
#include "gui/CGUIString.h"
#include "gui/GUIMatrix.h"
#include "graphics/ShaderManager.h"
#include "i18n/L10n.h"

3
source/gui/CGUIList.h
View file

@ -15,11 +15,10 @@
* along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef INCLUDED_CGUILIST
#define INCLUDED_CGUILIST
#include "GUItext.h"
#include "gui/CGUIString.h"
class CGUIList
{

0
source/gui/GUItext.cpp → source/gui/CGUIString.cpp
View file

229
source/gui/CGUIString.h Normal file
View file

@ -0,0 +1,229 @@
/* Copyright (C) 2019 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. 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 2 of the License, or
* (at your option) any later version.
*
* 0 A.D. 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 0 A.D. If not, see <http://www.gnu.org/licenses/>.
*/
/*
* GUI text, handles text stuff
*
* --Overview--
* Mainly contains struct SGUIText and friends.
* Actual text processing is made in CGUI::GenerateText()
*
* --More info--
* Check GUI.h
*
*/
#ifndef INCLUDED_CGUISTRING
#define INCLUDED_CGUISTRING
#include <list>
#include "gui/CGUISprite.h"
#include "gui/GUItext.h"
#include "ps/CStrIntern.h"
class CGUI;
/**
* String class, substitute for CStr, but that parses
* the tags and builds up a list of all text that will
* be different when outputted.
*
* The difference between CGUIString and SGUIText is that
* CGUIString is a string-class that parses the tags
* when the value is set. The SGUIText is just a container
* which stores the positions and settings of all text-calls
* that will have to be made to the Renderer.
*/
class CGUIString
{
public:
/**
* A chunk of text that represents one call to the renderer.
* In other words, all text in one chunk, will be drawn
* exactly with the same settings.
*/
struct TextChunk
{
/**
* A tag looks like this "Hello [b]there[/b] little"
*/
struct Tag
{
/**
* Tag Type
*/
enum TagType
{
TAG_B,
TAG_I,
TAG_FONT,
TAG_SIZE,
TAG_COLOR,
TAG_IMGLEFT,
TAG_IMGRIGHT,
TAG_ICON,
TAG_INVALID
};
struct TagAttribute
{
std::wstring attrib;
std::wstring value;
};
/**
* Set tag from string
*
* @param tagtype TagType by string, like 'img' for [img]
* @return True if m_TagType was set.
*/
bool SetTagType(const CStrW& tagtype);
TagType GetTagType(const CStrW& tagtype) const;
/**
* In [b="Hello"][/b]
* m_TagType is TAG_B
*/
TagType m_TagType;
/**
* In [b="Hello"][/b]
* m_TagValue is 'Hello'
*/
std::wstring m_TagValue;
/**
* Some tags need an additional attributes
*/
std::vector<TagAttribute> m_TagAttributes;
};
/**
* m_From and m_To is the range of the string
*/
int m_From, m_To;
/**
* Tags that are present. [a][b]
*/
std::vector<Tag> m_Tags;
};
/**
* All data generated in GenerateTextCall()
*/
struct SFeedback
{
// Avoid copying the vector and list containers.
NONCOPYABLE(SFeedback);
MOVABLE(SFeedback);
SFeedback() = default;
// Constants
static const int Left = 0;
static const int Right = 1;
/**
* Reset all member data.
*/
void Reset();
/**
* Image stacks, for left and right floating images.
*/
std::vector<CStr> m_Images[2]; // left and right
/**
* Text and Sprite Calls.
*/
std::vector<SGUIText::STextCall> m_TextCalls;
std::list<SGUIText::SSpriteCall> m_SpriteCalls; // list for consistent mem addresses
// so that we can point to elements.
/**
* Width and Height *feedback*
*/
CSize m_Size;
/**
* If the word inputted was a new line.
*/
bool m_NewLine;
};
/**
* Set the value, the string will automatically
* be parsed when set.
*/
void SetValue(const CStrW& str);
/**
* Get String, with tags
*/
const CStrW& GetOriginalString() const { return m_OriginalString; }
/**
* Get String, stripped of tags
*/
const CStrW& GetRawString() const { return m_RawString; }
/**
* Generate Text Call from specified range. The range
* must span only within ONE TextChunk though. Otherwise
* it can't be fit into a single Text Call
*
* Notice it won't make it complete, you will have to add
* X/Y values and such.
*
* @param pGUI Pointer to CGUI object making this call, for e.g. icon retrieval.
* @param Feedback contains all info that is generated.
* @param DefaultFont Default Font
* @param from From character n,
* @param to to character n.
* @param FirstLine Whether this is the first line of text, to calculate its height correctly
* @param pObject Only for Error outputting, optional! If NULL
* then no Errors will be reported! Useful when you need
* to make several GenerateTextCall in different phases,
* it avoids duplicates.
*/
void GenerateTextCall(const CGUI* pGUI, SFeedback& Feedback, CStrIntern DefaultFont, const int& from, const int& to, const bool FirstLine, const IGUIObject* pObject = NULL) const;
/**
* Words
*/
std::vector<int> m_Words;
private:
/**
* TextChunks
*/
std::vector<TextChunk> m_TextChunks;
/**
* The full raw string. Stripped of tags.
*/
CStrW m_RawString;
/**
* The original string value passed to SetValue.
*/
CStrW m_OriginalString;
};
#endif // INCLUDED_CGUISTRING

205
source/gui/GUItext.h
View file

@ -15,28 +15,15 @@
* along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
*/
/*
* GUI text, handles text stuff
*
* --Overview--
* Mainly contains struct SGUIText and friends.
* Actual text processing is made in CGUI::GenerateText()
*
* --More info--
* Check GUI.h
*
*/
#ifndef INCLUDED_GUITEXT
#define INCLUDED_GUITEXT
#include <list>
#include "CGUISprite.h"
#include "gui/CGUIColor.h"
#include "gui/CGUISprite.h"
#include "ps/CStrIntern.h"
class CGUI;
#include "ps/Shapes.h"
/**
* An SGUIText object is a parsed string, divided into
@ -163,192 +150,4 @@ struct SGUIText
CSize m_Size;
};
/**
* String class, substitute for CStr, but that parses
* the tags and builds up a list of all text that will
* be different when outputted.
*
* The difference between CGUIString and SGUIText is that
* CGUIString is a string-class that parses the tags
* when the value is set. The SGUIText is just a container
* which stores the positions and settings of all text-calls
* that will have to be made to the Renderer.
*/
class CGUIString
{
public:
/**
* A chunk of text that represents one call to the renderer.
* In other words, all text in one chunk, will be drawn
* exactly with the same settings.
*/
struct TextChunk
{
/**
* A tag looks like this "Hello [b]there[/b] little"
*/
struct Tag
{
/**
* Tag Type
*/
enum TagType
{
TAG_B,
TAG_I,
TAG_FONT,
TAG_SIZE,
TAG_COLOR,
TAG_IMGLEFT,
TAG_IMGRIGHT,
TAG_ICON,
TAG_INVALID
};
struct TagAttribute
{
std::wstring attrib;
std::wstring value;
};
/**
* Set tag from string
*
* @param tagtype TagType by string, like 'img' for [img]
* @return True if m_TagType was set.
*/
bool SetTagType(const CStrW& tagtype);
TagType GetTagType(const CStrW& tagtype) const;
/**
* In [b="Hello"][/b]
* m_TagType is TAG_B
*/
TagType m_TagType;
/**
* In [b="Hello"][/b]
* m_TagValue is 'Hello'
*/
std::wstring m_TagValue;
/**
* Some tags need an additional attributes
*/
std::vector<TagAttribute> m_TagAttributes;
};
/**
* m_From and m_To is the range of the string
*/
int m_From, m_To;
/**
* Tags that are present. [a][b]
*/
std::vector<Tag> m_Tags;
};
/**
* All data generated in GenerateTextCall()
*/
struct SFeedback
{
// Avoid copying the vector and list containers.
NONCOPYABLE(SFeedback);
MOVABLE(SFeedback);
SFeedback() = default;
// Constants
static const int Left = 0;
static const int Right = 1;
/**
* Reset all member data.
*/
void Reset();
/**
* Image stacks, for left and right floating images.
*/
std::vector<CStr> m_Images[2]; // left and right
/**
* Text and Sprite Calls.
*/
std::vector<SGUIText::STextCall> m_TextCalls;
std::list<SGUIText::SSpriteCall> m_SpriteCalls; // list for consistent mem addresses
// so that we can point to elements.
/**
* Width and Height *feedback*
*/
CSize m_Size;
/**
* If the word inputted was a new line.
*/
bool m_NewLine;
};
/**
* Set the value, the string will automatically
* be parsed when set.
*/
void SetValue(const CStrW& str);
/**
* Get String, with tags
*/
const CStrW& GetOriginalString() const { return m_OriginalString; }
/**
* Get String, stripped of tags
*/
const CStrW& GetRawString() const { return m_RawString; }
/**
* Generate Text Call from specified range. The range
* must span only within ONE TextChunk though. Otherwise
* it can't be fit into a single Text Call
*
* Notice it won't make it complete, you will have to add
* X/Y values and such.
*
* @param pGUI Pointer to CGUI object making this call, for e.g. icon retrieval.
* @param Feedback contains all info that is generated.
* @param DefaultFont Default Font
* @param from From character n,
* @param to to character n.
* @param FirstLine Whether this is the first line of text, to calculate its height correctly
* @param pObject Only for Error outputting, optional! If NULL
* then no Errors will be reported! Useful when you need
* to make several GenerateTextCall in different phases,
* it avoids duplicates.
*/
void GenerateTextCall(const CGUI* pGUI, SFeedback& Feedback, CStrIntern DefaultFont, const int& from, const int& to, const bool FirstLine, const IGUIObject* pObject = NULL) const;
/**
* Words
*/
std::vector<int> m_Words;
private:
/**
* TextChunks
*/
std::vector<TextChunk> m_TextChunks;
/**
* The full raw string. Stripped of tags.
*/
CStrW m_RawString;
/**
* The original string value passed to SetValue.
*/
CStrW m_OriginalString;
};
#endif // INCLUDED_GUITEXT