Locate and position the current Audacity source code, and clear a variety of old junk out of the way into junk-branches

src/xml/XMLTagHandler.h

@@ -0,0 +1,100 @@
+/**********************************************************************
+
+  Audacity: A Digital Audio Editor
+
+  XMLTagHandler.h
+
+  Dominic Mazzoni
+  Vaughan Johnson
+
+  The XMLTagHandler class is an interface which should be implemented by
+  classes which wish to be able to load and save themselves
+  using XML files.
+
+  The XMLValueChecker class implements static bool methods for checking 
+  input values from XML files.
+
+**********************************************************************/
+#ifndef __AUDACITY_XML_TAG_HANDLER__
+#define __AUDACITY_XML_TAG_HANDLER__
+
+#include "../Audacity.h"
+#include <wx/string.h>
+#include <stdio.h>
+
+#include "XMLWriter.h"
+class XMLValueChecker
+{
+public:
+   // "Good" means well-formed and for the file-related functions, names an existing file or folder.
+   // These are used in HandleXMLTag and BuildFomXML methods to check the input for 
+   // security vulnerabilites, per the NGS report for UmixIt.
+   static bool IsGoodString(const wxString str);
+
+   static bool IsGoodFileName(const wxString strFileName, const wxString strDirName = wxEmptyString);
+   static bool IsGoodSubdirName(const wxString strSubdirName, const wxString strDirName = wxEmptyString);
+   static bool IsGoodPathName(const wxString strPathName);
+
+   // Note that because wxString::ToLong does additional testing, IsGoodInt doesn't duplicate 
+   // that testing, so use wxString::ToLong after IsGoodInt, not just atoi.
+   static bool IsGoodInt(const wxString strInt);
+
+   static bool IsValidChannel(const int nValue); 
+   static bool IsValidSampleFormat(const int nValue); // true if nValue is one sampleFormat enum values
+
+   static bool IsGoodFileString(wxString str);
+};
+
+
+class AUDACITY_DLL_API XMLTagHandler {
+ public:
+   XMLTagHandler(){};
+   virtual ~XMLTagHandler(){};
+   //
+   // Methods to override
+   //
+
+   // This method will be called on your class if your class has
+   // been registered to handle this particular tag.  Parse the
+   // tag and the attribute-value pairs (null-terminated), and
+   // return true on success, and false on failure.  If you return
+   // false, you will not get any calls about children.
+   virtual bool HandleXMLTag(const wxChar *tag, const wxChar **attrs) = 0;
+
+   // This method will be called when a closing tag is encountered.
+   // It is optional to override this method.
+   virtual void HandleXMLEndTag(const wxChar *tag) {}
+
+   // This method will be called when element content has been
+   // encountered.
+   // It is optional to override this method.
+   virtual void HandleXMLContent(const wxString & content) {}
+
+   // If the XML document has children of your tag, this method
+   // should be called.  Typically you should construct a new
+   // object for the child, insert it into your own local data
+   // structures, and then return it.  If you do not wish to
+   // handle this child, return NULL and it will be ignored.
+   virtual XMLTagHandler *HandleXMLChild(const wxChar *tag) = 0;
+
+   // These functions recieve data from expat.  They do charset
+   // conversion and then pass the data to the handlers above.
+   bool ReadXMLTag(const char *tag, const char **attrs);
+   void ReadXMLEndTag(const char *tag);
+   void ReadXMLContent(const char *s, int len);
+   XMLTagHandler *ReadXMLChild(const char *tag);
+};
+
+#endif // define __AUDACITY_XML_TAG_HANDLER__
+
+// Indentation settings for Vim and Emacs and unique identifier for Arch, a
+// version control system. Please do not modify past this point.
+//
+// Local Variables:
+// c-basic-offset: 3
+// indent-tabs-mode: nil
+// End:
+//
+// vim: et sts=3 sw=3
+// arch-tag: 7c9a9baa-c546-42de-afaa-d87e5e13bf5a
+