PropertySpecification.h

00001 /*
00002  * This source file is part of libRocket, the HTML/CSS Interface Middleware
00003  *
00004  * For the latest information, see http://www.librocket.com
00005  *
00006  * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
00007  *
00008  * Permission is hereby granted, free of charge, to any person obtaining a copy
00009  * of this software and associated documentation files (the "Software"), to deal
00010  * in the Software without restriction, including without limitation the rights
00011  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00012  * copies of the Software, and to permit persons to whom the Software is
00013  * furnished to do so, subject to the following conditions:
00014  *
00015  * The above copyright notice and this permission notice shall be included in
00016  * all copies or substantial portions of the Software.
00017  * 
00018  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00019  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00020  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00021  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00022  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00023  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
00024  * THE SOFTWARE.
00025  *
00026  */
00027 
00028 #ifndef ROCKETCOREPROPERTYSPECIFICATION_H
00029 #define ROCKETCOREPROPERTYSPECIFICATION_H
00030 
00031 #include <Rocket/Core/Header.h>
00032 #include <Rocket/Core/Element.h>
00033 #include <Rocket/Core/PropertyDefinition.h>
00034 
00035 namespace Rocket {
00036 namespace Core {
00037 
00038 class PropertyDictionary;
00039 struct PropertyShorthandDefinition;
00040 
00047 class ROCKETCORE_API PropertySpecification
00048 {
00049 public:
00050         enum ShorthandType
00051         {
00052                 // Normal; properties that fail to parse fall-through to the next until they parse correctly, and any
00053                 // undeclared are not set.
00054                 FALL_THROUGH,
00055                 // A single failed parse will abort, and any undeclared are replicated from the last declared property.
00056                 REPLICATE,
00057                 // For 'padding', 'margin', etc; up four properties are expected.
00058                 BOX,
00059                 // BOX if four properties are shorthanded and they end in '-top', '-right', etc, otherwise FALL_THROUGH.
00060                 AUTO
00061         };
00062 
00063         PropertySpecification();
00064         ~PropertySpecification();
00065 
00072         PropertyDefinition& RegisterProperty(const String& property_name, const String& default_value, bool inherited, bool forces_layout);
00076         const PropertyDefinition* GetProperty(const String& property_name) const;
00077 
00080         void GetRegisteredProperties(PropertyNameList& properties) const;
00081 
00087         bool RegisterShorthand(const String& shorthand_name, const String& property_names, ShorthandType type = AUTO);
00091         const PropertyShorthandDefinition* GetShorthand(const String& shorthand_name) const;
00092 
00098         bool ParsePropertyDeclaration(PropertyDictionary& dictionary, const String& property_name, const String& property_value, const String& source_file = "", int source_line_number = 0) const;
00101         void SetPropertyDefaults(PropertyDictionary& dictionary) const;
00102 
00103 private:
00104         typedef std::map< String, PropertyDefinition* > PropertyMap;
00105         typedef std::map< String, PropertyShorthandDefinition* > ShorthandMap;
00106 
00107         PropertyMap properties;
00108         ShorthandMap shorthands;
00109 
00110         bool ParsePropertyValues(StringList& values_list, const String& values, bool split_values) const;
00111 };
00112 
00113 }
00114 }
00115 
00116 #endif