wml_error.hpp

Go to the documentation of this file.

/*
   Copyright (C) 2014 - 2016 by Ignacio R. Morelle <[email protected]>
   Part of the Battle for Wesnoth Project http://www.wesnoth.org/

   This program 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.
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY.

   See the COPYING file for more details.
*/

#ifndef GUI_DIALOGS_WML_ERROR_HPP_INCLUDED
#define GUI_DIALOGS_WML_ERROR_HPP_INCLUDED

#include "gui/dialogs/dialog.hpp"

namespace gui2
{

/** WML preprocessor/parser error report dialog. */
class twml_error : public tdialog
{
public:
    /**
     * Constructor.
     *
     * @param summary      Leading summary line for the report.
     * @param post_summary Additional line with instructions for the user, may
     *                     be empty.
     * @param files        List of WML files on which errors were detected.
     * @param details      Detailed WML preprocessor/parser error report.
     */
    twml_error(const std::string& summary,
               const std::string& post_summary,
               const std::vector<std::string>& files,
               const std::string& details);

    /** The display function; see @ref tdialog for more information. */
    static void display(const std::string& summary,
                        const std::string& post_summary,
                        const std::vector<std::string>& files,
                        const std::string& details,
                        CVideo& video)
    {
        twml_error(summary, post_summary, files, details).show(video);
    }

    /** The display function; see @ref tdialog for more information. */
    static void display(const std::string& summary,
                        const std::string& details,
                        CVideo& video)
    {
        display(summary, "", std::vector<std::string>(), details, video);
    }

private:
    bool have_files_;
    bool have_post_summary_;
    std::string report_; // Plain text report for copying to clipboard.

    /** Inherited from tdialog, implemented by REGISTER_DIALOG. */
    virtual const std::string& window_id() const;

    /** Inherited from tdialog. */
    void pre_show(twindow& window);

    void copy_report_callback();
};

} // end namespace gui2

#endif