Spinning Topp Logo BlackTopp Studios
inc
defaultmarkupparser.cpp
1 // © Copyright 2010 - 2016 BlackTopp Studios Inc.
2 /* This file is part of The Mezzanine Engine.
3 
4  The Mezzanine Engine is free software: you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation, either version 3 of the License, or
7  (at your option) any later version.
8 
9  The Mezzanine Engine is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with The Mezzanine Engine. If not, see <http://www.gnu.org/licenses/>.
16 */
17 /* The original authors have included a copy of the license specified above in the
18  'Docs' folder. See 'gpl.txt'
19 */
20 /* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
21  Build professional software and charge for their product.
22 
23  However there are some practical restrictions, so if your project involves
24  any of the following you should contact us and we will try to work something
25  out:
26  - DRM or Copy Protection of any kind(except Copyrights)
27  - Software Patents You Do Not Wish to Freely License
28  - Any Kind of Linking to Non-GPL licensed Works
29  - Are Currently In Violation of Another Copyright Holder's GPL License
30  - If You want to change our code and not add a few hundred MB of stuff to
31  your distribution
32 
33  These and other limitations could cause serious legal problems if you ignore
34  them, so it is best to simply contact us or the Free Software Foundation, if
35  you have any questions.
36 
37  Joseph Toppi - toppij@gmail.com
38  John Blackwood - makoenergy02@gmail.com
39 */
40 #ifndef _uidefaultmarkupparser_cpp
41 #define _uidefaultmarkupparser_cpp
42 
43 #include "UI/defaultmarkupparser.h"
44 #include "UI/textlayer.h"
45 #include "UI/screen.h"
46 #include "UI/textureatlas.h"
47 #include "stringtool.h"
48 
49 namespace Mezzanine
50 {
51  namespace UI
52  {
53  ///////////////////////////////////////////////////////////////////////////////
54  // DefaultColourTag Methods
55 
56  const String DefaultColourTag::TagName = "Colour";
57 
59  {
60  NameValuePairMap::iterator Colour = Params.find("Value");
61  if( Colour != Params.end() ) {
62  if( (*Colour).second.size() < 6 ) return ProcessResult(false,NULL);
63  else
64  {
65  Traits.CharColour = StringTools::ConvertHexToColourValue( (*Colour).second );
66  return ProcessResult(true,NULL);
67  }
68  }else{
69  return ProcessResult(false,NULL);
70  }
71  }
72 
73  ///////////////////////////////////////////////////////////////////////////////
74  // DefaultFontTag Methods
75 
76  const String DefaultFontTag::TagName = "Font";
77 
79  {
80  Screen* ParentScreen = Layer->GetScreen();
81  String AtlasName = Layer->GetPrimaryAtlas();
82 
83  NameValuePairMap::iterator FontName = Params.find("Name");
84  if( FontName != Params.end() ) {
85  Traits.CharFont = ParentScreen->GetFont( (*FontName).second,AtlasName );
86  }else{
87  return ProcessResult(false,NULL);
88  }
89 
90  /*NameValuePairMap::iterator FontSize = Params.find("Size");
91  if( FontSize != Params.end() ) {
92  Traits.CharFont->
93  }else{
94  return ProcessResult(false,NULL);
95  }// */
96 
97  return ProcessResult(true,NULL);
98  }
99 
100  ///////////////////////////////////////////////////////////////////////////////
101  // DefaultSpriteTag Methods
102 
103  const String DefaultSpriteTag::TagName = "Sprite";
104 
106  {
107  Screen* ParentScreen = Layer->GetScreen();
108  String AtlasName = Layer->GetPrimaryAtlas();
109  Character* ToInsert = NULL;
110 
111  NameValuePairMap::iterator SpriteName = Params.find("Name");
112  if( SpriteName != Params.end() ) {
113  Sprite* NewSprite = ParentScreen->GetSprite( (*SpriteName).second,AtlasName );
114  if( NewSprite )
115  ToInsert = new Character(NewSprite,Layer);
116  }else{
117  return ProcessResult(false,NULL);
118  }
119 
120  NameValuePairMap::iterator SpriteSize = Params.find("Size");
121  if( ToInsert && SpriteSize != Params.end() ) {
122  String SizeStr = (*SpriteSize).second;
123  SizeStr.replace( SizeStr.find_first_of('x'),1," " );
124  ToInsert->SetCustomSize( StringTools::ConvertToVector2(SizeStr) );
125  }
126 
127  return ProcessResult(true,ToInsert);
128  }
129 
130  ///////////////////////////////////////////////////////////////////////////////
131  // DefaultMarkupParser Methods
132 
134  { this->Initialize(); }
135 
137  {
138  for( TagIterator TagIt = this->Tags.begin() ; TagIt != this->Tags.end() ; ++TagIt )
139  { delete (*TagIt).second; }
140  this->Tags.clear();
141  }
142 
144  {
145  this->Tags.insert( std::pair<String,MarkupTag*>( DefaultColourTag::TagName,new DefaultColourTag() ) );
146  this->Tags.insert( std::pair<String,MarkupTag*>( DefaultFontTag::TagName,new DefaultFontTag() ) );
147  this->Tags.insert( std::pair<String,MarkupTag*>( DefaultSpriteTag::TagName,new DefaultSpriteTag() ) );
148  }
149 
150  ///////////////////////////////////////////////////////////////////////////////
151  // Utility
152 
154  { return "Default"; }
155 
157  { return '['; }
158 
160  { return ']'; }
161  }//UI
162 }//Mezzanine
163 
164 #endif
This class implements a character colour changing tag.
virtual Char8 GetMarkupTagStart() const
Gets the ID for the character that marks the start of a markup section.
TagContainer::iterator TagIterator
Iterator type for MarkupTag instances stored by this class.
Definition: markupparser.h:138
virtual ProcessResult Process(NameValuePairMap &Params, CharacterTraits &Traits, TextLayer *Layer) const
Processes this tag.
virtual String GetName() const
Gets the name of this parser implementation.
This class implements a character font changing tag.
static const String TagName
The name of this tag as it should appear in markup.
virtual ProcessResult Process(NameValuePairMap &Params, CharacterTraits &Traits, TextLayer *Layer) const
Processes this tag.
FontData * GetFont(const String &FontName, const String &Atlas) const
Gets the specified FontData from an Atlas.
Definition: screen.cpp:889
virtual Screen * GetScreen() const
Gets the screen the parent renderable is being rendered on.
This class stores common data for determining the look of a Character.
virtual ~DefaultMarkupParser()
Class destructor.
FontData * CharFont
The font this Character belongs to.
char Char8
A datatype to represent one character.
Definition: datatypes.h:169
TagContainer Tags
Map of tags recognized by this parser.
Definition: markupparser.h:157
This class creates and encapsultes a character that can be used in text renders.
Definition: character.h:59
static const String TagName
The name of this tag as it should appear in markup.
Sprite * GetSprite(const String &SpriteName, const String &Atlas) const
Gets a sprite from an Atlas.
Definition: screen.cpp:886
virtual Char8 GetMarkupTagEnd() const
Gets the ID for the character that marks the end of a markup section.
std::pair< Boole, Character * > ProcessResult
An std::pair used to report the result of a MarkupTag being processed any the character it may have g...
Definition: markupparser.h:76
virtual void Initialize()
Populates the tag map with the tags recognized by this parser.
ColourValue CharColour
The colour to render this Character as.
ColourValue ConvertHexToColourValue(const String &ToConvert)
Converts a Hex code in a string into a ColourValue.
Definition: stringtool.cpp:349
The bulk of the engine components go in this namspace.
Definition: actor.cpp:56
void SetCustomSize(const Vector2 &Size)
Sets the custom size this character is to be resized to.
Definition: character.cpp:327
static const String TagName
The name of this tag as it should appear in markup.
This class implements a sprite inserting tag.
virtual String GetPrimaryAtlas() const
Gets the currently set primary atlas.
virtual ProcessResult Process(NameValuePairMap &Params, CharacterTraits &Traits, TextLayer *Layer) const
Processes this tag.
std::map< String, String > NameValuePairMap
This is a datatype mostly used for describing settings or parameters that can't be declared in advanc...
Definition: datatypes.h:209
Vector2 ConvertToVector2(const String &ToConvert)
Convert two numbers in a string into a Vector2.
Definition: stringtool.cpp:281
This class is a helper class for creating UI's. It is responsible for storing and keeping track of al...
Definition: screen.h:142
Basic class used to describe a portion of a texture to be applied to a Quad.
Definition: sprite.h:55
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159
This is a base class for render layers that render text.
Definition: textlayer.h:64