3423e9afb265b1c3b2e3d94d10002c16243eaa03
[occt.git] / src / XmlMDataStd / XmlMDataStd_ByteArrayDriver.cxx
1 // Created on: 2007-05-29
2 // Created by: Vlad Romashko
3 // Copyright (c) 2007-2014 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
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.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16
17 #include <Message_Messenger.hxx>
18 #include <NCollection_LocalArray.hxx>
19 #include <Standard_Type.hxx>
20 #include <TColStd_HArray1OfByte.hxx>
21 #include <TDataStd_ByteArray.hxx>
22 #include <TDF_Attribute.hxx>
23 #include <XmlMDataStd.hxx>
24 #include <XmlMDataStd_ByteArrayDriver.hxx>
25 #include <XmlObjMgt.hxx>
26 #include <XmlObjMgt_Persistent.hxx>
27 IMPLEMENT_DOMSTRING (AttributeIDString, "bytearrattguid")
28
29 IMPLEMENT_STANDARD_RTTIEXT(XmlMDataStd_ByteArrayDriver,XmlMDF_ADriver)
30 IMPLEMENT_DOMSTRING (FirstIndexString, "first")
31 IMPLEMENT_DOMSTRING (LastIndexString,  "last")
32 IMPLEMENT_DOMSTRING (IsDeltaOn,        "delta")
33 //=======================================================================
34 //function : XmlMDataStd_ByteArrayDriver
35 //purpose  : Constructor
36 //=======================================================================
37 XmlMDataStd_ByteArrayDriver::XmlMDataStd_ByteArrayDriver(const Handle(Message_Messenger)& theMsgDriver)
38      : XmlMDF_ADriver (theMsgDriver, NULL)
39 {
40
41 }
42
43 //=======================================================================
44 //function : NewEmpty
45 //purpose  : 
46 //=======================================================================
47 Handle(TDF_Attribute) XmlMDataStd_ByteArrayDriver::NewEmpty() const
48 {
49   return new TDataStd_ByteArray();
50 }
51
52 //=======================================================================
53 //function : Paste
54 //purpose  : persistent -> transient (retrieve)
55 //=======================================================================
56 Standard_Boolean XmlMDataStd_ByteArrayDriver::Paste(const XmlObjMgt_Persistent&  theSource,
57                                                     const Handle(TDF_Attribute)& theTarget,
58                                                     XmlObjMgt_RRelocationTable&  ) const
59 {
60   Standard_Integer aFirstInd, aLastInd, aValue;
61   const XmlObjMgt_Element& anElement = theSource;
62
63   // Read the FirstIndex; if the attribute is absent initialize to 1
64   XmlObjMgt_DOMString aFirstIndex= anElement.getAttribute(::FirstIndexString());
65   if (aFirstIndex == NULL)
66     aFirstInd = 1;
67   else if (!aFirstIndex.GetInteger(aFirstInd)) 
68   {
69     TCollection_ExtendedString aMessageString =
70       TCollection_ExtendedString("Cannot retrieve the first index"
71                                  " for ByteArray attribute as \"")
72         + aFirstIndex + "\"";
73     myMessageDriver->Send (aMessageString, Message_Fail);
74     return Standard_False;
75   }
76
77   // Read the LastIndex; the attribute should be present
78   if (!anElement.getAttribute(::LastIndexString()).GetInteger(aLastInd)) 
79   {
80     TCollection_ExtendedString aMessageString =
81       TCollection_ExtendedString("Cannot retrieve the last index"
82                                  " for ByteArray attribute as \"")
83         + aFirstIndex + "\"";
84     myMessageDriver->Send (aMessageString, Message_Fail);
85     return Standard_False;
86   }
87
88   if (aFirstInd > aLastInd)
89   {
90     TCollection_ExtendedString aMessageString =
91       TCollection_ExtendedString("The last index is greater than the first index"
92                                  " for ByteArray attribute \"");
93     myMessageDriver->Send (aMessageString, Message_Fail);
94     return Standard_False;
95   }
96
97
98   Handle(TDataStd_ByteArray) aByteArray = Handle(TDataStd_ByteArray)::DownCast(theTarget);
99   
100   // attribute id
101   Standard_GUID aGUID;
102   XmlObjMgt_DOMString aGUIDStr = anElement.getAttribute(::AttributeIDString());
103   if (aGUIDStr.Type() == XmlObjMgt_DOMString::LDOM_NULL)
104     aGUID = TDataStd_ByteArray::GetID(); //default case
105   else
106     aGUID = Standard_GUID(Standard_CString(aGUIDStr.GetString())); // user defined case
107
108   aByteArray->SetID(aGUID);
109
110   Handle(TColStd_HArray1OfByte) hArr = new TColStd_HArray1OfByte(aFirstInd, aLastInd);
111   TColStd_Array1OfByte& arr = hArr->ChangeArray1();
112
113   Standard_CString aValueStr = Standard_CString(XmlObjMgt::GetStringValue(anElement).GetString());
114   Standard_Integer i = arr.Lower(), upper = arr.Upper();
115   for (; i <= upper; i++)
116   {
117     if (!XmlObjMgt::GetInteger(aValueStr, aValue)) 
118     {
119       TCollection_ExtendedString aMessageString =
120         TCollection_ExtendedString("Cannot retrieve integer member"
121                                    " for ByteArray attribute as \"")
122                                    + aValueStr + "\"";
123       myMessageDriver->Send (aMessageString, Message_Warning);
124       aValue = 0;
125     }
126     arr.SetValue(i, (Standard_Byte) aValue);
127   }
128   aByteArray->ChangeArray(hArr);
129   
130   Standard_Boolean aDelta(Standard_False);
131   
132   if(XmlMDataStd::DocumentVersion() > 2) {
133     Standard_Integer aDeltaValue;
134     if (!anElement.getAttribute(::IsDeltaOn()).GetInteger(aDeltaValue)) 
135     {
136       TCollection_ExtendedString aMessageString =
137         TCollection_ExtendedString("Cannot retrieve the isDelta value"
138                                    " for ByteArray attribute as \"")
139                                    + aDeltaValue + "\"";
140       myMessageDriver->Send (aMessageString, Message_Fail);
141       return Standard_False;
142     } 
143     else
144       aDelta = aDeltaValue != 0;
145   }
146 #ifdef OCCT_DEBUG
147   else if(XmlMDataStd::DocumentVersion() == -1)
148     cout << "Current DocVersion field is not initialized. "  <<endl;
149 #endif
150   aByteArray->SetDelta(aDelta);
151
152   return Standard_True;
153 }
154
155 //=======================================================================
156 //function : Paste
157 //purpose  : transient -> persistent (store)
158 //=======================================================================
159 void XmlMDataStd_ByteArrayDriver::Paste(const Handle(TDF_Attribute)& theSource,
160                                         XmlObjMgt_Persistent&        theTarget,
161                                         XmlObjMgt_SRelocationTable&  ) const
162 {
163   Handle(TDataStd_ByteArray) aByteArray = Handle(TDataStd_ByteArray)::DownCast(theSource);
164
165   Standard_Integer aL = aByteArray->Lower();
166   Standard_Integer anU = aByteArray->Upper();
167
168   theTarget.Element().setAttribute(::FirstIndexString(), aL);
169   theTarget.Element().setAttribute(::LastIndexString(), anU);
170   theTarget.Element().setAttribute(::IsDeltaOn(),aByteArray->GetDelta() ? 1 : 0);
171
172   const Handle(TColStd_HArray1OfByte)& hArr = aByteArray->InternalArray();
173   if (!hArr.IsNull() && hArr->Length())
174   {
175     // Access to data through an internal reprsentation of the array is faster.
176     const TColStd_Array1OfByte& arr = hArr->Array1();
177
178     // Allocate 4 characters (including a space ' ') for each byte (unsigned char) from the array.
179     NCollection_LocalArray<Standard_Character> str(4 * arr.Length() + 1);
180
181     // Char counter in the array of chars.
182     Standard_Integer iChar = 0;
183
184     // Iterate on the array of bytes and fill-in the array of chars inserting spacing between the chars.
185     Standard_Integer iByte = arr.Lower(); // position inside the byte array
186     for (; iByte <= arr.Upper(); ++iByte)
187     {
188       const Standard_Byte& byte = arr.Value(iByte);
189       iChar += Sprintf(&(str[iChar]), "%d ", byte);
190     }
191
192     // Transfer the string (array of chars) to XML.
193     XmlObjMgt::SetStringValue (theTarget, (Standard_Character*)str, Standard_True);
194   }
195   if(aByteArray->ID() != TDataStd_ByteArray::GetID()) {
196     //convert GUID
197     Standard_Character aGuidStr [Standard_GUID_SIZE_ALLOC];
198     Standard_PCharacter pGuidStr = aGuidStr;
199     aByteArray->ID().ToCString (pGuidStr);
200     theTarget.Element().setAttribute (::AttributeIDString(), aGuidStr);
201   }
202 }