ERRL: Ensure all Hostboot code uses ErrlUserDetails framework.

RTC: 36920

Change-Id: I82667c8e63e8a99b9cc7eb1dfbbbdbe1c3b2bb2a
Reviewed-on: http://gfw160.austin.ibm.com:8080/gerrit/730
Tested-by: Jenkins Server
Reviewed-by: A. Patrick Williams III <iawillia@us.ibm.com>

1 files changed, 134 insertions, 0 deletions

diff --git a/src/include/usr/errl/errludparserfactory.H b/src/include/usr/errl/errludparserfactory.H
new file mode 100755
index 000000000..ea39297cc
--- /dev/null
+++ b/src/include/usr/errl/errludparserfactory.H
@@ -0,0 +1,134 @@
+//  IBM_PROLOG_BEGIN_TAG
+//  This is an automatically generated prolog.
+//
+//  $Source: src/include/usr/errl/errludparserfactory.H $
+//
+//  IBM CONFIDENTIAL
+//
+//  COPYRIGHT International Business Machines Corp. 2012
+//
+//  p1
+//
+//  Object Code Only (OCO) source materials
+//  Licensed Internal Code Source Materials
+//  IBM HostBoot Licensed Internal Code
+//
+//  The source code for this program is not published or other-
+//  wise divested of its trade secrets, irrespective of what has
+//  been deposited with the U.S. Copyright Office.
+//
+//  Origin: 30
+//
+//  IBM_PROLOG_END
+#ifndef ERRL_UDPARSERFACTORY_H
+#define ERRL_UDPARSERFACTORY_H
+
+#ifdef PARSER
+
+/**
+ *  @file errludparserfactory.H
+ *
+ *  Defines the ErrlUserDetailsParserFactory base class
+ */
+#include <map>
+
+namespace ERRORLOG
+{
+
+/**
+ * @class ErrlUserDetailsParserFactory
+ *
+ * This is a factory that produces ErrlUserDetailsParser objects. If a component
+ * creates user detail data then it should derive a class from this and register
+ * all of its ErrlUserDetailsParser classes with it. The parse file in the
+ * plugins directory can then call the factory to create parser objects to parse
+ * any user detail data.
+ *
+ * This class is only compiled when PARSER is defined
+ */
+class ErrlUserDetailsParserFactory
+{
+public:
+    /**
+     *  @brief Constructor
+     */
+    ErrlUserDetailsParserFactory()
+    {
+    }
+
+    /**
+     *  @brief Destructor
+     */
+    ~ErrlUserDetailsParserFactory()
+    {
+    }
+
+    /**
+     *  @brief Register a class derived from ErrlUserDetailsParser with the
+     *         factory that can parse user detail data with the specified
+     *         subsection.
+     *
+     *  @param i_subSection The user detail data subsection that is parsed by
+     *                      class T
+     */
+    template<typename T>
+    void registerParser(const errlsubsec_t i_subSection)
+    {
+        iv_createObjectMap[i_subSection] = &(createParserObject<T>);
+    }
+
+    /**
+     *  @brief Create an object of type ErrlUserDetailsParser that can parse
+     *         user detail data with the specified subsection. The returned
+     *         pointer will be polymorphic and will actually point to a type
+     *         derived from ErrlUserDetailsParser.
+     *
+     *  @param i_subSection The user detail data subsection to parse
+     *
+     *  @return ErrlUserDetailsParser *
+     *      Pointer to a ErrlUserDetailsParser object. Null if there is no
+     *      parser registered for the specified subsection. The user must delete
+     *      the object after use.
+     */
+    ErrlUserDetailsParser * createParser(const errlsubsec_t i_subSection)
+    {
+        std::map<errlsubsec_t, createParserObject_t>::const_iterator itr =
+            iv_createObjectMap.find(i_subSection);
+
+        if (itr != iv_createObjectMap.end())
+        {
+            // Call the object creator function (createParserObject)
+            return((itr->second)());
+        }
+        return NULL;
+    }
+
+private:
+    /**
+     *  @brief Creates a ErrlUserDetailsParser of the specified derived type
+     *
+     *  @return ErrlUserDetailsParser * Pointer to newly created object
+     */
+    template<typename T>
+    static ErrlUserDetailsParser * createParserObject()
+    {
+        return new T();
+    }
+
+    // Function pointer type of createParserObject
+    typedef ErrlUserDetailsParser *(*createParserObject_t)();
+
+    // Map of subsections and their createobject function
+    std::map<errlsubsec_t, createParserObject_t> iv_createObjectMap;
+
+    // Disabled
+    ErrlUserDetailsParserFactory(const ErrlUserDetailsParserFactory &);
+    ErrlUserDetailsParserFactory & operator=(
+        const ErrlUserDetailsParserFactory &);
+};
+
+}
+
+#endif
+#endif
+