1 // Created on: 2004-09-27
2 // Created by: Pavel TELKOV
3 // Copyright (c) 2004-2014 OPEN CASCADE SAS
5 // This file is part of Open CASCADE Technology software library.
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
17 #include <CDM_MessageDriver.hxx>
18 #include <LDOM_MemManager.hxx>
19 #include <Standard_Type.hxx>
20 #include <TDataStd_ExtStringArray.hxx>
21 #include <TDF_Attribute.hxx>
22 #include <XmlMDataStd.hxx>
23 #include <XmlMDataStd_ExtStringArrayDriver.hxx>
24 #include <XmlObjMgt.hxx>
25 #include <XmlObjMgt_Document.hxx>
26 #include <XmlObjMgt_Persistent.hxx>
28 IMPLEMENT_STANDARD_RTTIEXT(XmlMDataStd_ExtStringArrayDriver,XmlMDF_ADriver)
29 IMPLEMENT_DOMSTRING (FirstIndexString, "first")
30 IMPLEMENT_DOMSTRING (LastIndexString, "last")
31 IMPLEMENT_DOMSTRING (ExtString, "string")
32 IMPLEMENT_DOMSTRING (IsDeltaOn, "delta")
33 IMPLEMENT_DOMSTRING (Separator, "separator")
35 // Searches for a symbol within an array of strings.
36 // Returns TRUE if the symbol is found.
37 static Standard_Boolean Contains(const Handle(TDataStd_ExtStringArray)& arr,
38 const TCollection_ExtendedString& c)
40 for (Standard_Integer i = arr->Lower(); i <= arr->Upper(); i++)
42 const TCollection_ExtendedString& value = arr->Value(i);
43 if (value.Search(c) != -1)
48 return Standard_False;
51 //=======================================================================
52 //function : XmlMDataStd_ExtStringArrayDriver
53 //purpose : Constructor
54 //=======================================================================
56 XmlMDataStd_ExtStringArrayDriver::XmlMDataStd_ExtStringArrayDriver
57 ( const Handle(CDM_MessageDriver)& theMsgDriver )
58 : XmlMDF_ADriver( theMsgDriver, NULL )
61 //=======================================================================
64 //=======================================================================
65 Handle(TDF_Attribute) XmlMDataStd_ExtStringArrayDriver::NewEmpty() const
67 return ( new TDataStd_ExtStringArray() );
70 //=======================================================================
72 //purpose : persistent -> transient (retrieve)
73 //=======================================================================
74 Standard_Boolean XmlMDataStd_ExtStringArrayDriver::Paste
75 ( const XmlObjMgt_Persistent& theSource,
76 const Handle(TDF_Attribute)& theTarget,
77 XmlObjMgt_RRelocationTable& ) const
79 Standard_Integer aFirstInd, aLastInd, ind;
80 TCollection_ExtendedString aValue;
81 const XmlObjMgt_Element& anElement = theSource;
83 // Read the FirstIndex; if the attribute is absent initialize to 1
84 XmlObjMgt_DOMString aFirstIndex= anElement.getAttribute(::FirstIndexString());
85 if (aFirstIndex == NULL)
87 else if (!aFirstIndex.GetInteger(aFirstInd)) {
88 TCollection_ExtendedString aMessageString =
89 TCollection_ExtendedString("Cannot retrieve the first index"
90 " for ExtStringArray attribute as \"")
92 WriteMessage (aMessageString);
93 return Standard_False;
96 // Read LastIndex; the attribute should be present
97 if (!anElement.getAttribute(::LastIndexString()).GetInteger(aLastInd)) {
98 TCollection_ExtendedString aMessageString =
99 TCollection_ExtendedString("Cannot retrieve the last index"
100 " for ExtStringArray attribute as \"")
101 + aFirstIndex + "\"";
102 WriteMessage (aMessageString);
103 return Standard_False;
107 TCollection_ExtendedString separator;
108 XmlObjMgt_DOMString aSeparator = anElement.getAttribute(::Separator());
109 if (aSeparator.Type() != XmlObjMgt_DOMString::LDOM_NULL)
110 separator = aSeparator.GetString();
112 Handle(TDataStd_ExtStringArray) aExtStringArray =
113 Handle(TDataStd_ExtStringArray)::DownCast(theTarget);
114 aExtStringArray->Init(aFirstInd, aLastInd);
116 // Read string values.
117 if ( !separator.Length() && anElement.hasChildNodes() )
119 // Read values written by <string>VALUE<\string> notion - as children of the attribute.
120 LDOM_Node aCurNode = anElement.getFirstChild();
121 LDOM_Element* aCurElement = (LDOM_Element*)&aCurNode;
122 TCollection_ExtendedString aValueStr;
123 for (ind = aFirstInd; ind <= aLastInd && *aCurElement != anElement.getLastChild(); ind++)
125 XmlObjMgt::GetExtendedString( *aCurElement, aValueStr );
126 aExtStringArray->SetValue(ind, aValueStr);
127 aCurNode = aCurElement->getNextSibling();
128 aCurElement = (LDOM_Element*)&aCurNode;
130 XmlObjMgt::GetExtendedString( *aCurElement, aValueStr );
131 aExtStringArray->SetValue( aLastInd, aValueStr );
135 TCollection_ExtendedString xstr;
136 XmlObjMgt::GetExtendedString(anElement, xstr);
138 TCollection_AsciiString cstr(xstr, '?');
141 // Split strings by the separator.
142 Standard_Integer isym(1); // index of symbol in xstr
143 Standard_ExtCharacter xsep = separator.Value(1);
144 for (ind = aFirstInd; ind <= aLastInd; ind++)
146 // Calculate length of the string-value.
147 Standard_Integer iend = isym;
148 while (iend < xstr.Length())
150 if (xstr.Value(iend) == xsep)
156 if (iend <= xstr.Length() &&
157 xstr.Value(iend) != xsep)
162 // Allocate the string-value.
163 TCollection_ExtendedString xvalue(iend - isym, '\0');
166 for (Standard_Integer i = isym; i < iend; ++i)
168 const Standard_ExtCharacter x = xstr.Value(i);
169 xvalue.SetValue(i - isym + 1, x);
172 TCollection_AsciiString cvalue(xvalue, '?');
175 // Set value for the array.
176 aExtStringArray->SetValue(ind, xvalue);
178 // Next string-value.
184 Standard_Boolean aDelta(Standard_False);
186 if(XmlMDataStd::DocumentVersion() > 2) {
187 Standard_Integer aDeltaValue;
188 if (!anElement.getAttribute(::IsDeltaOn()).GetInteger(aDeltaValue))
190 TCollection_ExtendedString aMessageString =
191 TCollection_ExtendedString("Cannot retrieve the isDelta value"
192 " for IntegerArray attribute as \"")
193 + aDeltaValue + "\"";
194 WriteMessage (aMessageString);
195 return Standard_False;
198 aDelta = aDeltaValue != 0;
201 else if(XmlMDataStd::DocumentVersion() == -1)
202 cout << "Current DocVersion field is not initialized. " <<endl;
204 aExtStringArray->SetDelta(aDelta);
206 return Standard_True;
209 //=======================================================================
211 //purpose : transient -> persistent (store)
212 //=======================================================================
213 void XmlMDataStd_ExtStringArrayDriver::Paste (const Handle(TDF_Attribute)& theSource,
214 XmlObjMgt_Persistent& theTarget,
215 XmlObjMgt_SRelocationTable& ) const
217 Handle(TDataStd_ExtStringArray) aExtStringArray =
218 Handle(TDataStd_ExtStringArray)::DownCast(theSource);
220 Standard_Integer aL = aExtStringArray->Lower(), anU = aExtStringArray->Upper(), i;
222 XmlObjMgt_Element& anElement = theTarget;
224 if (aL != 1) anElement.setAttribute(::FirstIndexString(), aL);
225 anElement.setAttribute(::LastIndexString(), anU);
226 anElement.setAttribute(::IsDeltaOn(), aExtStringArray->GetDelta() ? 1 : 0);
229 Standard_Boolean found(Standard_True);
230 // Preferrable symbols for the separator: - _ . : ^ ~
231 // Don't use a space as a separator: XML low-level parser sometimes "eats" it.
232 Standard_Character c = '-';
233 static Standard_Character aPreferable[] = "-_.:^~";
234 for (i = 0; found && aPreferable[i]; i++)
237 found = Contains(aExtStringArray, TCollection_ExtendedString(c));
239 // If all prefferable symbols exist in the array,
240 // try to use any other simple symbols.
244 while (found && c < '~')
246 found = Standard_False;
248 TCollection_AsciiString cseparator(c); // deb
250 TCollection_ExtendedString separator(c);
251 found = Contains(aExtStringArray, separator);
255 // Skip forbidden symbols for XML.
256 while (c < '~' && (c == '&' || c == '<'))
266 // There is no unique separator. Use child elements for storage of strings of the array.
268 // store a set of elements with string in each of them
269 XmlObjMgt_Document aDoc (anElement.getOwnerDocument());
270 for ( i = aL; i <= anU; i++ )
272 const TCollection_ExtendedString& aValueStr = aExtStringArray->Value( i );
273 XmlObjMgt_Element aCurTarget = aDoc.createElement( ::ExtString() );
274 XmlObjMgt::SetExtendedString( aCurTarget, aValueStr );
275 anElement.appendChild( aCurTarget );
280 // Set the separator.
281 TCollection_AsciiString csep(c);
282 anElement.setAttribute(::Separator(), csep.ToCString());
284 // Calculate length of the common string.
285 Standard_Integer len(0);
286 for (i = aL; i <= anU; i++)
288 const TCollection_ExtendedString& aValueStr = aExtStringArray->Value(i);
289 len += aValueStr.Length();
290 len++; // for separator or ending \0 symbol
293 len++; // for end of line \0 symbol
295 // Merge all strings of the array into one extended string separated by the "separator".
296 Standard_Integer isym(1);
297 TCollection_ExtendedString xstr(len, c);
298 for (i = aL; i <= anU; i++)
300 const TCollection_ExtendedString& aValueStr = aExtStringArray->Value(i);
301 for (Standard_Integer k = 1; k <= aValueStr.Length(); k++)
303 xstr.SetValue(isym++, aValueStr.Value(k));
305 xstr.SetValue(isym++, c);
307 if (xstr.SearchFromEnd(c) == isym - 1)
308 isym--; // replace the last separator by '\0'
309 xstr.SetValue(isym, '\0');
311 TCollection_AsciiString cstr(xstr, '?'); // deb
314 // Set UNICODE value.
315 XmlObjMgt::SetExtendedString(theTarget, xstr);