RigDef_Validator.h

Go to the documentation of this file.

/*
    This source file is part of Rigs of Rods
    Copyright 2005-2012 Pierre-Michel Ricordel
    Copyright 2007-2012 Thomas Fischer
    Copyright 2013-2020 Petr Ohlidal
 
    For more information, see http://www.rigsofrods.org/
 
    Rigs of Rods is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License version 3, as
    published by the Free Software Foundation.
 
    Rigs of Rods 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 Rigs of Rods. If not, see <http://www.gnu.org/licenses/>.
*/
 
#pragma once
 
#include "RigDef_File.h"
 
#include <memory>
#include <OgreString.h>
 
namespace RigDef
{
 
class Validator
{
public:
    
    struct Message // TODO: remove, use console API directly
    {
        enum Type
        {
            TYPE_INFO,
            TYPE_WARNING,
            TYPE_ERROR,
            TYPE_FATAL_ERROR,
 
            TYPE_INVALID = 0xFFFFFFFF
        };
    };
 
    void Setup(RigDef::DocumentPtr file);
 
    bool AddModule(Ogre::String const & module_name);
 
    bool Validate();
 
    void SetCheckBeams(bool check_beams)
    {
        m_check_beams = check_beams;
    }
 
private:
 
    bool CheckSectionSubmeshGroundmodel();
 
    bool CheckGearbox();
 
    void AddMessage(Validator::Message::Type type, Ogre::String const & text);
 
/* -------------------------------------------------------------------------- */
/* Individual section checkers.                                               */
/* -------------------------------------------------------------------------- */    
 
    bool CheckShock2(RigDef::Shock2 & shock2);
 
    bool CheckShock3(RigDef::Shock3 & shock3);
 
    bool CheckAnimator(RigDef::Animator & def);
 
    bool CheckCommand(RigDef::Command2 & def);
 
    bool CheckTrigger(RigDef::Trigger & def);
 
    bool CheckVideoCamera(RigDef::VideoCamera & def);
 
    bool CheckFlare2(RigDef::Flare2 & def);
 
/* -------------------------------------------------------------------------- */
/* Properties                                                                 */
/* -------------------------------------------------------------------------- */
 
    RigDef::DocumentPtr m_file; 
    std::list<std::shared_ptr<RigDef::Document::Module>> m_selected_modules;
    bool m_check_beams;
 
};
 
} // namespace RigDef