Merge pull request #1 from saurabhb17/develop

Secondary files

1 files changed, 168 insertions, 0 deletions

diff --git a/include/reporter.h b/include/reporter.h
new file mode 100644
index 0000000..47fc17f
--- /dev/null
+++ b/include/reporter.h
@@ -0,0 +1,168 @@
+#ifndef _REPORTER_H_
+#define _REPORTER_H_
+
+/**
+ * @file reporter.h
+ * @author Wayne Stambaugh
+ * @note A special thanks to Dick Hollenbeck who came up with the idea that inspired
+ *       me to write this.
+ */
+
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2013 Wayne Stambaugh <stambaughw@verizon.net>
+ * Copyright (C) 1992-2013 KiCad Developers, see change_log.txt for contributors.
+ *
+ * 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; 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 this program; if not, you may find one here:
+ * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
+ * or you may search the http://www.gnu.org website for the version 2 license,
+ * or you may write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+ */
+
+
+class wxString;
+class wxTextCtrl;
+class wxHtmlListbox;
+class WX_HTML_REPORT_PANEL;
+
+
+/**
+ * Class REPORTER
+ * is a pure virtual class used to derive REPORTER objects from.
+ *
+ * The purpose of the REPORTER object is to offer a way for a procedural function
+ * to report multiple errors without having to:
+ * <ul>
+ * <li> know too much about the caller's UI, i.e. wx. </li>
+ * <li> stop after the first error </li>
+ * </ul>
+ * the reporter has 4 severity levels (flags) tagging the messages:
+ * - information
+ * - warning
+ * - error
+ * - action (i.e. indication of changes - add component, change footprint, etc. )
+ * They are indicators for the message formatting and displaying code,
+ * filtering is not made here.
+ */
+
+class REPORTER {
+
+public:
+    ///> Severity of the reported messages.
+    enum SEVERITY {
+        RPT_UNDEFINED = 0x0,
+        RPT_INFO      = 0x1,
+        RPT_WARNING   = 0x2,
+        RPT_ERROR     = 0x4,
+        RPT_ACTION    = 0x8
+    };
+
+    /**
+     * Function Report
+     * is a pure virtual function to override in the derived object.
+     *
+     * @param aText is the string to report.
+     */
+
+    virtual REPORTER& Report( const wxString& aText, SEVERITY aSeverity = RPT_UNDEFINED ) = 0;
+
+    REPORTER& Report( const char* aText, SEVERITY aSeverity = RPT_UNDEFINED );
+
+    REPORTER& operator <<( const wxString& aText ) { return Report( aText ); }
+
+    REPORTER& operator <<( const wxChar* aText ) { return Report( wxString( aText ) ); }
+
+    REPORTER& operator <<( wxChar aChar ) { return Report( wxString( aChar ) ); }
+
+    REPORTER& operator <<( const char* aText ) { return Report( aText ); }
+};
+
+
+/**
+ * Class WX_TEXT_CTRL_REPORTER
+ * is wrapper for reporting to a wxTextCtrl object.
+ */
+class WX_TEXT_CTRL_REPORTER : public REPORTER
+{
+    wxTextCtrl* m_textCtrl;
+
+public:
+    WX_TEXT_CTRL_REPORTER( wxTextCtrl* aTextCtrl ) :
+        REPORTER(),
+        m_textCtrl( aTextCtrl )
+    {
+    }
+
+    REPORTER& Report( const wxString& aText, SEVERITY aSeverity = RPT_UNDEFINED );
+};
+
+
+/**
+ * Class WX_STRING_REPORTER
+ * is a wrapper for reporting to a wxString object.
+ */
+class WX_STRING_REPORTER : public REPORTER
+{
+    wxString* m_string;
+
+public:
+    WX_STRING_REPORTER( wxString* aString ) :
+        REPORTER(),
+        m_string( aString )
+    {
+    }
+
+    REPORTER& Report( const wxString& aText, SEVERITY aSeverity = RPT_UNDEFINED );
+};
+
+
+/**
+ * Class WX_HTML_PANEL_REPORTER
+ * is a wrapper for reporting to a wx HTML window
+ */
+class WX_HTML_PANEL_REPORTER : public REPORTER
+{
+    WX_HTML_REPORT_PANEL* m_panel;
+
+public:
+    WX_HTML_PANEL_REPORTER( WX_HTML_REPORT_PANEL* aPanel ) :
+        REPORTER(),
+        m_panel( aPanel )
+    {
+    }
+
+    REPORTER& Report( const wxString& aText, SEVERITY aSeverity = RPT_UNDEFINED );
+};
+
+/**
+ * Class NULL_REPORTER
+ *
+ * A singleton reporter that reports to nowhere. Used as to simplify code by
+ * avoiding the reportee to check for a non-NULL reporter object.
+ */
+class NULL_REPORTER : public REPORTER
+{
+    public:
+        NULL_REPORTER()
+        {
+        };
+
+        static REPORTER& GetInstance();
+
+        REPORTER& Report( const wxString& aText, SEVERITY aSeverity = RPT_UNDEFINED );
+};
+
+#endif     // _REPORTER_H_