Download data/src/xml/xml.cc from introvoyz041/mujoco: direct link, hf CLI and curl.
- Browser
- Download file 12.4 kB
-
https://huggingface.co/datasets/introvoyz041/mujoco/resolve/main/data/src/xml/xml.cc
- Command line
-
hf download hf://datasets/introvoyz041/mujoco/data/src/xml/xml.cc
-
curl -L -o xml.cc https://huggingface.co/datasets/introvoyz041/mujoco/resolve/main/data/src/xml/xml.cc
12.4 kB
| // Copyright 2021 DeepMind Technologies Limited | |
| // | |
| // Licensed under the Apache License, Version 2.0 (the "License"); | |
| // you may not use this file except in compliance with the License. | |
| // You may obtain a copy of the License at | |
| // | |
| // http://www.apache.org/licenses/LICENSE-2.0 | |
| // | |
| // Unless required by applicable law or agreed to in writing, software | |
| // distributed under the License is distributed on an "AS IS" BASIS, | |
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| // See the License for the specific language governing permissions and | |
| // limitations under the License. | |
| namespace { | |
| using tinyxml2::XMLDocument; | |
| using tinyxml2::XMLElement; | |
| using tinyxml2::XMLNode; | |
| using mujoco::user::FilePath; | |
| namespace mju = ::mujoco::util; | |
| // We are using "locale-sensitive" sprintf to read and write XML. | |
| // When MuJoCo is being used as a plug-in for an application that respects the system locale | |
| // (e.g. Unity), the user's locale setting can affect the formatting of numbers into strings. | |
| // Specifically, a number of European locales (e.g. de_DE) uses commas to as decimal separators. | |
| // In order to ensure that XMLs are locale-inpendent, we temporarily switch to the "C" locale | |
| // when handling. Since the standard C `setlocale` is not thread-safe, we instead use | |
| // platform-specific extensions to override the locale only in the calling thread. | |
| // See also https://github.com/google-deepmind/mujoco/issues/131. | |
| class LocaleOverride { | |
| public: | |
| LocaleOverride() | |
| : old_per_thread_locale_type_(_configthreadlocale(0)), | |
| old_locale_(setlocale(LC_ALL, nullptr)) { | |
| _configthreadlocale(_ENABLE_PER_THREAD_LOCALE); | |
| setlocale(LC_ALL, "C"); | |
| } | |
| ~LocaleOverride() { | |
| setlocale(LC_ALL, old_locale_.c_str()); | |
| _configthreadlocale(old_per_thread_locale_type_); | |
| } | |
| private: | |
| int old_per_thread_locale_type_; | |
| std::string old_locale_; | |
| }; | |
| class LocaleOverride { | |
| public: | |
| static locale_t PosixLocale() { | |
| static locale_t posix_locale = newlocale(LC_ALL_MASK, "C", 0); | |
| return posix_locale; | |
| } | |
| LocaleOverride() : old_locale_(uselocale(PosixLocale())) {} | |
| ~LocaleOverride() { | |
| uselocale(old_locale_); | |
| } | |
| private: | |
| locale_t old_locale_; | |
| }; | |
| void RegisterResourceProvider() { | |
| // register string resource provider if not registered before | |
| if (mjp_getResourceProvider("LoadModelFromString:") == nullptr) { | |
| mjpResourceProvider resourceProvider; | |
| mjp_defaultResourceProvider(&resourceProvider); | |
| resourceProvider.prefix = "LoadModelFromString"; | |
| resourceProvider.open = +[](mjResource* resource) { | |
| resource->data = &(resource->name[strlen("LoadModelFromString:")]); | |
| return 1; | |
| }; | |
| resourceProvider.read = | |
| +[](mjResource* resource, const void** buffer) { | |
| *buffer = resource->data; | |
| return (int) strlen((const char*) resource->data); | |
| }; | |
| resourceProvider.close = +[](mjResource* resource) {}; | |
| mjp_registerResourceProvider(&resourceProvider); | |
| } | |
| } | |
| // find include elements recursively, replace them with subtree from xml file | |
| void IncludeXML(mjXReader& reader, XMLElement* elem, | |
| const FilePath& dir, const mjVFS* vfs, | |
| std::unordered_set<std::string>& included) { | |
| // capture directory defaults on first pass of XML tree | |
| if (!strcasecmp(elem->Value(), "compiler")) { | |
| auto assetdir_attr = mjXUtil::ReadAttrStr(elem, "assetdir"); | |
| if (assetdir_attr.has_value()) { | |
| reader.SetAssetDir(assetdir_attr.value()); | |
| } | |
| auto texturedir_attr = mjXUtil::ReadAttrStr(elem, "texturedir"); | |
| if (texturedir_attr.has_value()) { | |
| reader.SetTextureDir(texturedir_attr.value()); | |
| } | |
| auto meshdir_attr = mjXUtil::ReadAttrStr(elem, "meshdir"); | |
| if (meshdir_attr.has_value()) { | |
| reader.SetMeshDir(meshdir_attr.value()); | |
| } | |
| } | |
| // not an include, recursively go through all children | |
| if (strcasecmp(elem->Value(), "include")) { | |
| XMLElement* child = elem->FirstChildElement(); | |
| for (; child; child = child->NextSiblingElement()) { | |
| IncludeXML(reader, child, dir, vfs, included); | |
| } | |
| return; | |
| } | |
| // make sure include has no children | |
| if (!elem->NoChildren()) { | |
| throw mjXError(elem, "Include element cannot have children"); | |
| } | |
| // get filename | |
| auto file_attr = mjXUtil::ReadAttrFile(elem, "file", vfs, | |
| reader.ModelFileDir(), true); | |
| if (!file_attr.has_value()) { | |
| throw mjXError(elem, "Include element missing file attribute"); | |
| } | |
| FilePath filename = file_attr.value(); | |
| // block repeated include files | |
| if (included.find(filename.Str()) != included.end()) { | |
| throw mjXError(elem, "File '%s' already included", filename.c_str()); | |
| } | |
| // TODO: b/325905702 - We have a messy wrapper here to remain backwards | |
| // compatible, which will be removed in the near future. | |
| // legacy behavior: try to load in top level directory | |
| std::array<char, 1024> error; | |
| mjResource *resource = mju_openResource(reader.ModelFileDir().c_str(), | |
| filename.c_str(), vfs, | |
| error.data(), error.size()); | |
| if (resource == nullptr) { | |
| // new behavior: try to load in relative directory | |
| if (!filename.IsAbs()) { | |
| FilePath fullname = dir + filename; | |
| resource = mju_openResource(reader.ModelFileDir().c_str(), | |
| fullname.c_str(), vfs, error.data(), error.size()); | |
| } | |
| } | |
| if (resource == nullptr) { | |
| throw mjXError(elem, "%s", error.data()); | |
| } | |
| filename = dir + filename; | |
| const char* include_dir = nullptr; | |
| int ninclude_dir = 0; | |
| mju_getResourceDir(resource, &include_dir, &ninclude_dir); | |
| FilePath next_dir = FilePath(std::string(include_dir, ninclude_dir)); | |
| elem->SetAttribute("dir", next_dir.c_str()); | |
| const char* xmlstring = nullptr; | |
| int buffer_size = mju_readResource(resource, (const void**) &xmlstring); | |
| if (buffer_size < 0) { | |
| mju_closeResource(resource); | |
| throw mjXError(elem, "Error reading file '%s'", filename.c_str()); | |
| } else if (!buffer_size) { | |
| mju_closeResource(resource); | |
| throw mjXError(elem, "Empty file '%s'", filename.c_str()); | |
| } | |
| // load XML file or parse string | |
| XMLDocument doc; | |
| doc.Parse(xmlstring, buffer_size); | |
| // close resource | |
| mju_closeResource(resource); | |
| // check error | |
| if (doc.Error()) { | |
| char err[1000]; | |
| mju::sprintf_arr(err, "XML parse error %d:\n%s\n", doc.ErrorID(), doc.ErrorStr()); | |
| throw mjXError(elem, "Include error: '%s'", err); | |
| } | |
| // remember that file was included | |
| included.insert(filename.Str()); | |
| // get and check root element | |
| XMLElement* docroot = doc.RootElement(); | |
| if (!docroot) { | |
| throw mjXError(elem, "Root element missing in file '%s'", filename.c_str()); | |
| } | |
| // get and check first child | |
| XMLElement* eleminc = docroot->FirstChildElement(); | |
| if (!eleminc) { | |
| throw mjXError(elem, "Empty include file '%s'", filename.c_str()); | |
| } | |
| // get <include> element | |
| XMLElement* include = elem->ToElement(); | |
| XMLDocument* include_doc = include->GetDocument(); | |
| // clone first child of included document | |
| XMLNode* first = include->InsertFirstChild(eleminc->DeepClone(include_doc)); | |
| // point to first | |
| XMLElement* child = first->ToElement(); | |
| // insert remaining elements from included document as siblings | |
| eleminc = eleminc->NextSiblingElement(); | |
| while (eleminc) { | |
| child = include->InsertAfterChild(child, eleminc->DeepClone(include_doc))->ToElement(); | |
| eleminc = eleminc->NextSiblingElement(); | |
| } | |
| // recursively run include | |
| child = include->FirstChildElement(); | |
| for (; child; child = child->NextSiblingElement()) { | |
| IncludeXML(reader, child, next_dir, vfs, included); | |
| } | |
| } | |
| } // namespace | |
| // Main parser function | |
| mjSpec* ParseXML(const char* filename, const mjVFS* vfs, | |
| char* error, int nerror) { | |
| LocaleOverride locale_override; | |
| // check arguments | |
| if (!filename) { | |
| if (error) { | |
| std::snprintf(error, nerror, "ParseXML: filename argument required\n"); | |
| } | |
| return nullptr; | |
| } | |
| // clear | |
| mjSpec* spec = nullptr; | |
| if (error) { | |
| error[0] = '\0'; | |
| } | |
| // get data source | |
| const char* xmlstring = nullptr; | |
| std::array<char, 1024> rerror; | |
| mjResource* resource = mju_openResource("", filename, vfs, | |
| rerror.data(), rerror.size()); | |
| if (resource == nullptr) { | |
| std::snprintf(error, nerror, "ParseXML: %s", rerror.data()); | |
| return nullptr; | |
| } | |
| int buffer_size = mju_readResource(resource, (const void**) &xmlstring); | |
| if (buffer_size < 0) { | |
| if (error) { | |
| std::snprintf(error, nerror, | |
| "ParseXML: error reading file '%s'", filename); | |
| } | |
| mju_closeResource(resource); | |
| return nullptr; | |
| } else if (!buffer_size) { | |
| if (error) { | |
| std::snprintf(error, nerror, "ParseXML: empty file '%s'", filename); | |
| } | |
| mju_closeResource(resource); | |
| return nullptr; | |
| } | |
| // load XML file or parse string | |
| XMLDocument doc; | |
| doc.Parse(xmlstring, buffer_size); | |
| // error checking | |
| if (doc.Error()) { | |
| if (error) { | |
| snprintf(error, nerror, "XML parse error %d:\n%s\n", | |
| doc.ErrorID(), doc.ErrorStr()); | |
| } | |
| mju_closeResource(resource); | |
| return nullptr; | |
| } | |
| // get top-level element | |
| XMLElement* root = doc.RootElement(); | |
| if (!root) { | |
| mju_closeResource(resource); | |
| mjCopyError(error, "XML root element not found", nerror); | |
| return nullptr; | |
| } | |
| // create model, set filedir | |
| spec = mj_makeSpec(); | |
| const char* dir; | |
| int ndir = 0; | |
| mju_getResourceDir(resource, &dir, &ndir); | |
| if (dir != nullptr) { | |
| mjs_setString(spec->modelfiledir, std::string(dir, ndir).c_str()); | |
| } else { | |
| mjs_setString(spec->modelfiledir, ""); | |
| } | |
| // close resource | |
| mju_closeResource(resource); | |
| // parse with exceptions | |
| try { | |
| if (!strcasecmp(root->Value(), "mujoco")) { | |
| // find include elements, replace them with subtree from xml file | |
| std::unordered_set<std::string> included = {filename}; | |
| mjXReader parser; | |
| parser.SetModelFileDir(mjs_getString(spec->modelfiledir)); | |
| IncludeXML(parser, root, FilePath(), vfs, included); | |
| // parse MuJoCo model | |
| parser.SetModel(spec); | |
| parser.Parse(root, vfs); | |
| } | |
| else if (!strcasecmp(root->Value(), "robot")) { | |
| // parse URDF model | |
| mjXURDF parser; | |
| // set reasonable default for parsing a URDF | |
| // this is separate from the Parser to allow multiple URDFs to be loaded. | |
| spec->strippath = true; | |
| spec->compiler.fusestatic = true; | |
| spec->compiler.discardvisual = true; | |
| parser.SetModel(spec); | |
| parser.Parse(root); | |
| } | |
| else { | |
| throw mjXError(0, "Unrecognized XML model type: '%s'", root->Value()); | |
| } | |
| } | |
| // catch known errors | |
| catch (mjXError err) { | |
| mjCopyError(error, err.message, nerror); | |
| mj_deleteSpec(spec); | |
| return nullptr; | |
| } | |
| return spec; | |
| } | |
| mjSpec* ParseSpecFromString(std::string_view xml, const mjVFS* vfs, char* error, int nerror) { | |
| RegisterResourceProvider(); | |
| std::string xml2 = {xml.begin(), xml.end()}; | |
| std::string str = "LoadModelFromString:" + xml2; | |
| return ParseXML(str.c_str(), vfs, error, nerror); | |
| } | |
| // Main writer function - calls mjXWrite | |
| std::string WriteXML(const mjModel* m, mjSpec* spec, char* error, int nerror) { | |
| LocaleOverride locale_override; | |
| // check for empty model | |
| if (!spec) { | |
| mjCopyError(error, "Cannot write empty model", nerror); | |
| return ""; | |
| } | |
| mjXWriter writer; | |
| writer.SetModel(spec, m); | |
| try { | |
| return writer.Write(error, nerror); | |
| } catch (mjXError err) { | |
| mjCopyError(error, err.message, nerror); | |
| return ""; | |
| } | |
| } | |