Changeset 163 for trunk/lingosource/castlib2/PseudoXMLPS.ls

Timestamp:

04/06/08 11:11:43 (4 years ago)

Author:

alex

Message:

now with version checking

File:

• trunk/lingosource/castlib2/PseudoXMLPS.ls (modified) (11 diffs)

trunk/lingosource/castlib2/PseudoXMLPS.ls

@@ +1 @@
+-- PseudoXMLPS
+-----------------------------------
+-- CREATED:
+-- 06.03.2008
+--
+-- DESCRIPTION:
 -- Pseudo XML by Alex da Franca ©2003
 -- Convert a lingo list to a XML like string and back
 
--- alex am Freitag 21.April.2006 16:31:57
---------------------------------------------------------
--- fixed a bug in "mBuildXMLString" many thanks to Olaf Schliesing for pointing this out
-
--- alex am 28.11.06 um 16:41:00
---------------------------------------------------------
--- finally added a tag property, when writing xml, so the ilk of the object gets stored
--- so, when reading back the xml file, we do not convert a node by accident to a value
--- when a string evaluates to a value "by accident"
-
----------------------------------
--- Scriptmarker: changes alex (04.04.2007 at 10:22 Uhr) // Scriptmarker
--- added  escaping of: 
---                     & -> &
---                     ' -> '
---                     " -> "
--- and vice versa. Until now I only escaped < and >, but ampersand, apostrophe and quote must also be escaped for proper xml
-
--- I als added "support" for the CData tag, which allows you to escape the whole contents of a node.
--- support is only done through ignoring esaping the special characters, wehn BUILDING the xml string.
--- So the user can decide on his own, which nodes s/he wants to be masked inside a CData section
--- (otherwise I'd have to mask EVERY string and try to unmask EVERY node. Now the user is on his own)
-
--- Example:
+--
+-- REQUIRES:
+-- (Prerequisites)
+--
+-- USAGE:
 -- myList = [#stringWithInvalidChars:"A string with invalid chars like <> and & and ' and " & QUOTE]
 -- myList[#stringWithInvalidChars] = "<![CDATA[" & myList[#stringWithInvalidChars] & "]]>"
@@ -41 +28 @@
 --   end if
 -- end repeat
+--
+-- HISTORY:
+
+--              alex am Freitag 21.April.2006 16:31:57
+--              fixed a bug in "mBuildXMLString" many thanks to Olaf Schliesing for pointing this out
+--
+--              alex am 28.11.06 um 16:41:00
+--              finally added a tag property, when writing xml, so the ilk of the object gets stored
+--              so, when reading back the xml file, we do not convert a node by accident to a value
+--              when a string evaluates to a value "by accident"
+--
+--              Scriptmarker: changes alex (04.04.2007 at 10:22 Uhr) // Scriptmarker
+--              added  escaping of: 
+--                                   & -> &amp;
+--                                   ' -> &apos;
+--                                   " -> &quot;
+--              and vice versa. Until now I only escaped < and >, but ampersand, apostrophe and quote must also be escaped for proper xml
+--              I als added "support" for the CData tag, which allows you to escape the whole contents of a node.
+--              support is only done through ignoring esaping the special characters, wehn BUILDING the xml string.
+--              So the user can decide on his own, which nodes s/he wants to be masked inside a CData section
+--              (otherwise I'd have to mask EVERY string and try to unmask EVERY node. Now the user is on his own)
+-- TODO:
+-- -
+-----------------------------------
+
+
+
+
+
+
 
 
@@ -112 +129 @@
 -- xxxxxxxxxxxxxxxxxx Convert lingo list (also nested lists) to XML stylish string
 
--- Parameters:
+on mGetXMLStringFromList me, listref, docName, strict, dontReplaceGT, withParams
+  -----------------------------------
+  -- CREATED: 06.03.2008
+  -- ACTION: Convert lingo list (also nested lists) to XML stylish string
+  -- INPUT: 
 -- <listref> format: property list or linear list
 -- <docName> format: #string; optional. if omitted "Untitled" is used for the XML document name
--- strict        => boolean; avoid spaces in tag names
--- dontReplaceGT => boolean; dont replace < and >
--- withParams    => boolean; write attribute in tag for the lingo ilk => bigger xml files and unfortunately it is slower to parse
+  --              <strict>        => boolean; avoid spaces in tag names
+  --              <dontReplaceGT> => boolean; dont replace < and >
+  --              <withParams>    => boolean; write attribute in tag for the lingo ilk => bigger xml files and unfortunately it is slower to parse
 ----------------------------- (I thought avoiding value() would help, but in this case the additional text parsing of the attributes tag slows down)
-
--- Example:
--- saveString = mGetXMLStringFromList(me, lingo_list, "documentName")
-
-on mGetXMLStringFromList me, listref, docName, strict, dontReplaceGT, withParams
+  -- RETURNS: string
+  -- EXAMPLE: saveString = mGetXMLStringFromList(me, lingo_list, "documentName")
+  -----------------------------------
+  
   --  ms = the milliseconds
   if voidP(strict) then strict = 0
@@ -152 +172 @@
 -- xxxxxxxxxxxxxxxxxx Convert XML stylish string to lingo list
 
--- Parameters:
+
+on mGetListFromXMLString me, str, convertValues, withParams
+  -----------------------------------
+  -- CREATED: 06.03.2008
+  -- ACTION: Description
+  -- INPUT:
 -- <str> format: #string; split a string using <> and </> tags into lingo list
 -- <convertValues> #integer 0=>don't convert (fast, all values are strings), 1 => convert only numbers (slower); 2 => try to convert all data, even colors (slow)
-
--- Example:
--- lingo_list = mGetListFromXMLString(me, saveString)
-
-on mGetListFromXMLString me, str, convertValues, withParams
+  --          <withParams> : #boolean : parse parameters too. new, not very well tested
+  -- RETURNS: property list
+  -- EXAMPLE: lingo_list = mGetListFromXMLString(me, saveString)
+  -- CHANGES: implemented parameter parsing
+  -----------------------------------
   
   ms = the milliseconds
@@ -193 +218 @@
 
 -- xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
--- MUCH FASTER than the above: Use the XML xtra to parse the string
--- BUT it must be a valid xml string, the above is slower but allows more malformed xml
-
--- Parameters:
+
+
+property pXmlxtraversion
+
+on mGetListFromXMLStringX me, str, convertValues, withParams
+  -----------------------------------
+  -- CREATED: 06.03.2008
+  -- ACTION: Convert xml string to lingo list using the xmlparser xtra, if possible
+  --         MUCH FASTER than the above: Use the XML xtra to parse the string
+  --         BUT it must be a valid xml string, the above is slower but allows more malformed xml
+  -- INPUT: 
 -- <str> format: #string; split a string using <> and </> tags into lingo list
 -- <convertValues> #integer
@@ -202 +234 @@
 -- -- -- 1 => convert only integer() and float() (slower)
 -- -- -- 2 => try to convert all data with value(), even parse for colors in hexstring format (slow)
-
--- Example:
--- lingo_list = mGetListFromXMLStringX(me, saveString)
-
-property pXmlxtraversion
-
-on mGetListFromXMLStringX me, str, convertValues, withParams
+  -- RETURNS: property list
+  -- EXAMPLE: lingo_list = mGetListFromXMLStringX(me, saveString)
+  -- CHANGES: resorts to the slower lingo function on xml parser error. So this handler can always be used.
+  -----------------------------------
   
   if ilk(str) <> #string then str = string(str)
@@ -289 +318 @@
   
 end
+
+-- xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+on _______________READ_WRITE_EXTERNAL_FILES
+end
+-- xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+
+on mReadXML_2_List me, thePath
+  -----------------------------------
+  -- CREATED: 06.03.2008
+  -- ACTION: read external xml file to lingo list
+  -- INPUT: <thePath> : string ; optional pathname. if no pathname or "", then a file save dialog is shown
+  -- RETURNS: property list
+  -----------------------------------
+  
+  dertext = xscr(#FileIOFunktionen).mGetTextFromFile(thePath)
+  if length(dertext) > 0 then return xscr(#PseudoXMLPS).mGetListFromXMLStringX(dertext)
+  return [:]
+end
+
+-- xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+
+on mSaveList_2_XML me, theList, thePath
+  -----------------------------------
+  -- CREATED: 06.03.2008
+  -- ACTION: write liongo list to external xml file
+  -- INPUT: 
+  --          <theList> : linear or property list
+  --          <thePath> : string ; optional pathname. if no pathname or "", then a file selection dialog is shown
+  -- RETURNS: full pathname of newly created file, if successful, otherwise 0
+  -----------------------------------
+  
+  if not(listP(theList)) then return 0
+  theResult = xscr(#PseudoXMLPS).mGetXMLStringFromList(theList)
+  return xscr(#FileIOFunktionen).mSaveToTextFile(theResult, thePath)
+end
+
 
 -- xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
@@ -940 +1005 @@
         
         if ilk(retlist) = #proplist then
-          retlist.addProp(symbol(inputlist[n].getaprop(#name)), val)
+        retlist.addProp(symbol(inputlist[n].getaprop(#name)), val)
         else
           retlist.add(val)
@@ -994 +1059 @@
                         
                       else
-                        call(#mPut, [mGetXScript(#commonmoviescript)], "mParseExcelXML: Row "&n&" Cell "&m&" is not a property list")
+                        call(#mPut, mGetXScript(), "mParseExcelXML: Row "&n&" Cell "&m&" is not a property list")
                       end if -- if ilk(thisCell) = #proplist then
                       
@@ -1000 +1065 @@
                     
                   else
-                    call(#mPut, [mGetXScript(#commonmoviescript)], "mParseExcelXML: Row "&n&" is not a list")
+                    call(#mPut, mGetXScript(), "mParseExcelXML: Row "&n&" is not a list")
                   end if -- if listP(currRow) then
                   
@@ -1006 +1071 @@
                 
               else
-                call(#mPut, [mGetXScript(#commonmoviescript)], "mParseExcelXML: Table not found")
+                call(#mPut, mGetXScript(), "mParseExcelXML: Table not found")
               end if -- if listP(xmlList) then
               
             else
-              call(#mPut, [mGetXScript(#commonmoviescript)], "mParseExcelXML: Worksheet not found")
+              call(#mPut, mGetXScript(), "mParseExcelXML: Worksheet not found")
             end if -- if ilk(xmlList) = #proplist then
             
           else
-            call(#mPut, [mGetXScript(#commonmoviescript)], "mParseExcelXML: Workbook not found")
+            call(#mPut, mGetXScript(), "mParseExcelXML: Workbook not found")
           end if -- if ilk(xmlList) = #proplist then
           
         else
-          call(#mPut, [mGetXScript(#commonmoviescript)], "mParseExcelXML: ROOT is not a property list")
+          call(#mPut, mGetXScript(), "mParseExcelXML: ROOT is not a property list")
         end if --if ilk(xmlList) = #proplist then
         
       else
-        call(#mPut, [mGetXScript(#commonmoviescript)], "mParseExcelXML: Xml parser makelist() returned empty list")
+        call(#mPut, mGetXScript(), "mParseExcelXML: Xml parser makelist() returned empty list")
       end if -- if count(xmlList) > 0 then
       
     else
-      call(#mPut, [mGetXScript(#commonmoviescript)], "mParseExcelXML: Xml parser makelist() failed")
+      call(#mPut, mGetXScript(), "mParseExcelXML: Xml parser makelist() failed")
     end if -- if listP(xmlList) then
     
   else
-    call(#mPut, [mGetXScript(#commonmoviescript)], "mParseExcelXML: Xml parser error: "&xmlp.getError())
+    call(#mPut, mGetXScript(), "mParseExcelXML: Xml parser error: "&xmlp.getError())
   end if -- if voidP(xmlp.getError()) then