use enumeration for HTML standard

Author: striezel

code/bbcode/BBCodeParser.cpp

@@ -1,7 +1,7 @@
 /*
  -------------------------------------------------------------------------------
     This file is part of the Private Message Database.
-    Copyright (C) 2012, 2013  Dirk Stolle
+    Copyright (C) 2012, 2013, 2025  Dirk Stolle
 
     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
@@ -36,58 +36,51 @@ BBCodeParser::BBCodeParser()
 {
 }
 
-std::string BBCodeParser::parse(std::string text, const std::string& forumURL, const bool isXHTML, const bool nl2br) const
+std::string BBCodeParser::parse(std::string text, const std::string& forumURL, const HTMLStandard standard, const bool nl2br) const
 {
   #ifndef NO_PREPROCESSORS_IN_PARSER
-  //handle pre processors
-  std::vector<TextProcessor*>::const_iterator pre_iter = m_PreProcs.begin();
-  while (pre_iter!=m_PreProcs.end())
+  // handle pre processors
+  for (const auto * pre_ptr: m_PreProcs)
   {
-    (*pre_iter)->applyToText(text);
-    ++pre_iter;
-  }//while
+    pre_ptr->applyToText(text);
+  }
   #endif
 
-  //handle line breaks
+  // handle line breaks
   if (nl2br)
   {
     std::string::size_type pos = text.find("\n");
-    while (pos!=std::string::npos)
+    const bool isXHTML = standard == HTMLStandard::XHTML;
+    while (pos != std::string::npos)
     {
       text.replace(pos, 1, isXHTML ? "<br />\n" : "<br>\n");
-      pos = text.find("\n", isXHTML ? pos+7 : pos+5);
-    }//while
-  }//if
+      pos = text.find("\n", isXHTML ? pos + 7 : pos + 5);
+    }
+  } // if
 
-  //handle bb codes
-  std::vector<BBCode*>::const_iterator iter = m_Codes.begin();
-  while (iter!=m_Codes.end())
+  // handle bb codes
+  for (const BBCode* code: m_Codes)
   {
-    (*iter)->applyToText(text);
-    ++iter;
-  }//while
+    code->applyToText(text);
+  }
 
   #ifndef NO_SMILIES_IN_PARSER
-  //handle smilies
-  std::vector<Smilie>::const_iterator sm_iter = m_Smilies.begin();
-  while (sm_iter!=m_Smilies.end())
+  // handle smilies
+  for (const auto& sm: m_Smilies)
   {
-    sm_iter->applyToText(text, forumURL, isXHTML);
-    ++sm_iter;
-  }//while
+    sm.applyToText(text, forumURL, standard);
+  }
   #endif
 
-  //handle quotes
+  // handle quotes
   text = handleQuotes(text, forumURL);
 
   #ifndef NO_POSTPROCESSORS_IN_PARSER
-  //handle post processors
-  std::vector<TextProcessor*>::const_iterator post_iter = m_PostProcs.begin();
-  while (post_iter!=m_PostProcs.end())
+  // handle post processors
+  for (const auto* post_ptr: m_PostProcs)
   {
-    (*post_iter)->applyToText(text);
-    ++post_iter;
-  }//while
+    post_ptr->applyToText(text);
+  }
   #endif
 
   return text;
@@ -96,14 +89,14 @@ std::string BBCodeParser::parse(std::string text, const std::string& forumURL, c
 #ifndef NO_PREPROCESSORS_IN_PARSER
 void BBCodeParser::addPreProcessor(TextProcessor* preProc)
 {
-  if (preProc!=NULL)
+  if (preProc != nullptr)
     m_PreProcs.push_back(preProc);
 }
 #endif
 
 void BBCodeParser::addCode(BBCode* code)
 {
-  if (code!=NULL)
+  if (code != nullptr)
     m_Codes.push_back(code);
 }
 
@@ -117,7 +110,7 @@ void BBCodeParser::addSmilie(const Smilie& sm)
 #ifndef NO_POSTPROCESSORS_IN_PARSER
 void BBCodeParser::addPostProcessor(TextProcessor* postProc)
 {
-  if (postProc!=NULL)
+  if (postProc != nullptr)
     m_PostProcs.push_back(postProc);
 }
 #endif

code/bbcode/BBCodeParser.hpp

@@ -1,7 +1,7 @@
 /*
  -------------------------------------------------------------------------------
     This file is part of the Private Message Database.
-    Copyright (C) 2012, 2013, 2014  Dirk Stolle
+    Copyright (C) 2012, 2013, 2014, 2025  Dirk Stolle
 
     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
@@ -36,6 +36,7 @@
 #include <string>
 #include <vector>
 #include "BBCode.hpp"
+#include "HTMLStandard.hpp"
 #ifndef NO_SMILIES_IN_PARSER
   #include "Smilie.hpp"
 #endif
@@ -44,34 +45,32 @@
 #endif
 
 /** \brief BBCodeParser:
-       transforms a given text containing BB codes to HTML code via the
+       Transforms a given text containing BB codes to (X)HTML code via the
        parse() function. All codes that should be replaced have to be added
        before parsing. Use addCode() for that. Smilies added via addSmilie()
        will be replaced, too.
 */
 class BBCodeParser
 {
   public:
-    /** constructor */
     BBCodeParser();
 
 
-    /** \brief transforms BB codes in text to HTML codes (still incomplete)
+    /** \brief Transforms BB codes in text to (X)HTML codes (still incomplete).
      *
      * \param text       the original text
      * \param forumURL   the base URL of the forum (some BB codes might require
-                         this URL for proper transformation of code to HTML)
-     * \param isXHTML    if set to true, smilie transformations will produce XHTML
-                         image tags
+                         this URL for proper transformation of code to (X)HTML)
+     * \param standard   the HTML standard to use during transformation (HTML or XHTML)
      * \param nl2br      if set to true, new line characters will be converted to
                          the corresponding (X)HTML code for line breaks
      * \return Returns the transformed/parsed text.
      */
-    std::string parse(std::string text, const std::string& forumURL, const bool isXHTML, const bool nl2br) const;
+    std::string parse(std::string text, const std::string& forumURL, const HTMLStandard standard, const bool nl2br) const;
 
 
     #ifndef NO_PREPROCESSORS_IN_PARSER
-    /** \brief adds a new text preprocessor to the parser
+    /** \brief Adds a new text preprocessor to the parser.
      *
      * \param preProc  pointer to the text processor object that should be added
      * \remarks The passed pointers must live for the whole lifetime of the
@@ -92,7 +91,7 @@ class BBCodeParser
     #endif
 
 
-    /** \brief adds a new bb code to the parser
+    /** \brief Adds a new BB code to the parser.
      *
      * \param code   pointer to the BB code object that should be added
      * \remarks
@@ -113,16 +112,16 @@ class BBCodeParser
 
 
     #ifndef NO_SMILIES_IN_PARSER
-    /** \brief adds a new smilie to the parser
+    /** \brief Adds a new smilie to the parser.
      *
-     * \param sm   the smilie
+     * \param sm   the smilie to add
      */
     void addSmilie(const Smilie& sm);
     #endif
 
 
     #ifndef NO_POSTPROCESSORS_IN_PARSER
-    /** \brief adds a new text postprocessor to the parser
+    /** \brief Adds a new text postprocessor to the parser.
      *
      * \param postProc   pointer to the text processor object that should be added
      *
@@ -145,26 +144,26 @@ class BBCodeParser
     #endif
 
     #ifndef NO_PREPROCESSORS_IN_PARSER
-    /** clears all added preprocessors */
+    /** Clears all added preprocessors. */
     inline void clearPreProcessors()
     {
       m_PreProcs.clear();
     }
     #endif
 
 
-    /** \brief clears all added BB codes
+    /** \brief Clears all added BB codes.
      *
      * \remarks
      *  Clearing codes right before calling parse() without any addCode()
      *  calls in between will result in no BB codes being parsed. However,
-     *  smilies might still get parsed.
+     *  smilies might still get parsed, if there are any.
      */
     void clearCodes();
 
 
     #ifndef NO_SMILIES_IN_PARSER
-    /** \brief clears all added smilies
+    /** \brief Clears all added smilies.
      *
      * \remarks
      * Clearing smilies right before calling parse() without any addSmile()
@@ -175,7 +174,7 @@ class BBCodeParser
     #endif
 
     #ifndef NO_POSTPROCESSORS_IN_PARSER
-    /** clears all added postprocessors */
+    /** Clears all added postprocessors. */
     inline void clearPostProcessors()
     {
       m_PostProcs.clear();
@@ -192,6 +191,6 @@ class BBCodeParser
     std::vector<TextProcessor*> m_PostProcs;
     #endif
     std::vector<BBCode*> m_Codes;
-};//class
+}; // class
 
 #endif // BBCODEPARSER_HPP

code/bbcode/HorizontalRuleBBCode.cpp

@@ -1,7 +1,7 @@
 /*
  -------------------------------------------------------------------------------
     This file is part of the Private Message Database.
-    Copyright (C) 2012, 2015, 2016  Dirk Stolle
+    Copyright (C) 2012, 2015, 2016, 2025  Dirk Stolle
 
     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
@@ -21,17 +21,17 @@
 #include "HorizontalRuleBBCode.hpp"
 #include "../../libstriezel/common/StringUtils.hpp"
 
-HorizontalRuleBBCode::HorizontalRuleBBCode(const std::string& code, const bool isXHTML)
-: BBCode(code), m_isXHTML(isXHTML)
+HorizontalRuleBBCode::HorizontalRuleBBCode(const std::string& code, const HTMLStandard standard)
+: BBCode(code), m_standard(standard)
 { }
 
 void HorizontalRuleBBCode::applyToText(std::string& text) const
 {
-  const std::string code = "["+getName()+"][/"+getName()+"]";
+  const std::string code = "[" + getName() + "][/" + getName() + "]";
   std::string::size_type pos = find_ci(text, code);
-  while (pos!=std::string::npos)
+  while (pos != std::string::npos)
   {
-    text.replace(pos, code.length(), m_isXHTML ? "<hr />" : "<hr>");
+    text.replace(pos, code.length(), m_standard == HTMLStandard::XHTML ? "<hr />" : "<hr>");
     pos = find_ci(text, code);
-  }//while
+  }
 }

code/bbcode/HorizontalRuleBBCode.hpp

@@ -1,7 +1,7 @@
 /*
  -------------------------------------------------------------------------------
     This file is part of the Private Message Database.
-    Copyright (C) 2012, 2014, 2015  Dirk Stolle
+    Copyright (C) 2012, 2014, 2015, 2025  Dirk Stolle
 
     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
@@ -23,28 +23,30 @@
 
 #include <string>
 #include "BBCode.hpp"
+#include "HTMLStandard.hpp"
 
 /** \brief HorizontalRuleBBCode:
        struct for hr BB code
 */
 struct HorizontalRuleBBCode: public BBCode
 {
   public:
-    /** constructor
+    /** Creates a new instance.
      *
-     * \param code   "name" of the code, i.e. "b" for [B]bold text[/B]
+     * \param code      "name" of the code, i.e. "b" for [B]bold text[/B]
+     * \param standard  the HTML standard to use during transformation (HTML or XHTML)
      */
-    HorizontalRuleBBCode(const std::string& code, const bool isXHTML);
+    HorizontalRuleBBCode(const std::string& code, const HTMLStandard standard);
 
 
-    /** \brief "applies" the BB code to the given text, i.e. transforms the BB code
-     * into its HTML representation
+    /** \brief "Applies" the BB code to the given text, i.e. transforms the BB code
+     * into its (X)HTML representation.
      *
      * \param text   the message text that (may) contain the BB code
      */
     virtual void applyToText(std::string& text) const;
   private:
-    bool m_isXHTML;
-};//struct HorizontalRuleBBCode
+    HTMLStandard m_standard;
+}; // struct
 
 #endif // HORIZONTALRULEBBCODE_HPP

code/bbcode/Smilie.cpp

@@ -25,13 +25,13 @@ Smilie::Smilie(const std::string& code, const std::string& url, const UrlType ur
 {
 }
 
-void Smilie::applyToText(std::string& text, const std::string& forumURL, const bool isXHTML) const
+void Smilie::applyToText(std::string& text, const std::string& forumURL, const HTMLStandard standard) const
 {
   std::string::size_type pos = text.find(m_Code);
 
   const std::string replacement = "<img src=\""
                                 + (type_of_url == UrlType::Relative ? forumURL + m_URL : m_URL) + "\" alt=\"" + m_Code
-                                + (isXHTML ? "\" border=\"0\" />" : "\" border=\"0\">");
+                                + (standard == HTMLStandard::XHTML ? "\" border=\"0\" />" : "\" border=\"0\">");
   while (pos != std::string::npos)
   {
     text.replace(pos, m_Code.length(), replacement);

code/bbcode/Smilie.hpp

@@ -1,7 +1,7 @@
 /*
  -------------------------------------------------------------------------------
     This file is part of the Private Message Database.
-    Copyright (C) 2012  Dirk Stolle
+    Copyright (C) 2012, 2025  Dirk Stolle
 
     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
@@ -22,6 +22,7 @@
 #define SMILIE_HPP
 
 #include <string>
+#include "HTMLStandard.hpp"
 
 enum class UrlType: bool
 {
@@ -48,10 +49,9 @@ struct Smilie
      *
      * \param text       the message text that (may) contain the smilie code
      * \param forumURL   base URL of the forum
-     * \param isXHTML    if set to true, the replacement will XHTML code. Otherwise
-     *                   HTML code is used.
+     * \param standard   Indicates the HTML standard to use for the replacement (HTML or XHTML).
      */
-    void applyToText(std::string& text, const std::string& forumURL, const bool isXHTML) const;
+    void applyToText(std::string& text, const std::string& forumURL, const HTMLStandard standard) const;
   private:
     std::string m_Code;
     std::string m_URL;