Skip to content

Improve material script error reporting with file and line context #1657

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
arjo129 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improve material script error reporting with file and line context #1657

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b19d588
Improve material script error reporting with file and line context
arjo129 May 11, 2026
1376180
Merge branch 'main' into arjoc/feat/material_err
arjo129 May 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion include/sdf/Material.hh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,9 +208,18 @@ namespace sdf
public: const std::string &FilePath() const;

/// \brief Set the path to the file where this element was loaded from.
/// \paramp[in] _filePath Full path to the file on disk.
/// \param[in] _filePath Full path to the file on disk.
public: void SetFilePath(const std::string &_filePath);

/// \brief Get the line number of this material within the SDF document.
/// \return Line number of this material if it has been set, nullopt
/// otherwise.
public: std::optional<int> LineNumber() const;

/// \brief Set the line number of this material within the SDF document.
/// \param[in] _lineNumber Line number of material.
public: void SetLineNumber(int _lineNumber);

/// \brief Create and return an SDF element filled with data from this
/// material.
/// Note that parameter passing functionality is not captured with this
Expand Down
221 changes: 125 additions & 96 deletions src/Material.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,9 @@ class sdf::Material::Implementation

/// \brief The path to the file where this material was defined.
public: std::string filePath = "";

/// \brief The line number where this material was defined.
public: std::optional<int> lineNumber;
};

/////////////////////////////////////////////////
Expand All @@ -97,6 +100,7 @@ Errors Material::Load(sdf::ElementPtr _sdf, const sdf::ParserConfig &_config)
this->dataPtr->sdf = _sdf;

this->dataPtr->filePath = _sdf->FilePath();
this->dataPtr->lineNumber = _sdf->LineNumber();

// Check that the provided SDF element is a <material>
// This is an error that cannot be recovered, so return an error.
Expand All @@ -105,120 +109,133 @@ Errors Material::Load(sdf::ElementPtr _sdf, const sdf::ParserConfig &_config)
errors.push_back({ErrorCode::ELEMENT_INCORRECT_TYPE,
"Attempting to load a Material, but the provided SDF element is not a "
"<material>."});
return errors;
}

// Load the script information
if (_sdf->HasElement("script"))
else
{
sdf::ElementPtr elem = _sdf->GetElement("script", errors);
std::pair<std::string, bool> uriPair =
elem->Get<std::string>(errors, "uri", "");
if (uriPair.first == "__default__")
uriPair.first = "";

if (!uriPair.second || uriPair.first.empty())
{
errors.push_back({ErrorCode::ELEMENT_INVALID,
"A <script> element is missing a child <uri> element, or the "
"<uri> element is empty."});
}

std::unordered_set<std::string> paths;
if (!this->dataPtr->filePath.empty())
{
paths.insert(std::filesystem::path(
this->dataPtr->filePath).parent_path().string());
}
this->dataPtr->scriptUri = resolveURI(uriPair.first, _config, errors,
paths);

std::pair<std::string, bool> namePair =
elem->Get<std::string>(errors, "name", "");
if (namePair.first == "__default__")
namePair.first = "";

if (!namePair.second || namePair.first.empty())
// Load the script information
if (_sdf->HasElement("script"))
{
errors.push_back({ErrorCode::ELEMENT_MISSING,
"A <script> element is missing a child <name> element, or the "
"<name> element is empty."});
sdf::ElementPtr elem = _sdf->GetElement("script", errors);
std::pair<std::string, bool> uriPair =
elem->Get<std::string>(errors, "uri", "");
if (uriPair.first == "__default__")
uriPair.first = "";

if (!uriPair.second || uriPair.first.empty())
{
errors.push_back({ErrorCode::ELEMENT_INVALID,
"A <script> element is missing a child <uri> element, or the "
"<uri> element is empty."});
}

std::unordered_set<std::string> paths;
if (!this->dataPtr->filePath.empty())
{
paths.insert(std::filesystem::path(
this->dataPtr->filePath).parent_path().string());
}
this->dataPtr->scriptUri = resolveURI(uriPair.first, _config, errors,
paths);

std::pair<std::string, bool> namePair =
elem->Get<std::string>(errors, "name", "");
if (namePair.first == "__default__")
namePair.first = "";

if (!namePair.second || namePair.first.empty())
{
errors.push_back({ErrorCode::ELEMENT_MISSING,
"A <script> element is missing a child <name> element, or the "
"<name> element is empty."});
}
this->dataPtr->scriptName = namePair.first;
}
this->dataPtr->scriptName = namePair.first;
}

// Load the shader information
if (_sdf->HasElement("shader"))
{
sdf::ElementPtr elem = _sdf->GetElement("shader", errors);

std::pair<std::string, bool> typePair =
elem->Get<std::string>(errors, "type", "pixel");
if (typePair.first == "pixel")
this->dataPtr->shader = ShaderType::PIXEL;
else if (typePair.first == "vertex")
this->dataPtr->shader = ShaderType::VERTEX;
else if (typePair.first == "normal_map_objectspace")
this->dataPtr->shader = ShaderType::NORMAL_MAP_OBJECTSPACE;
else if (typePair.first == "normal_map_object_space")
this->dataPtr->shader = ShaderType::NORMAL_MAP_OBJECTSPACE;
else if (typePair.first == "normal_map_tangentspace")
this->dataPtr->shader = ShaderType::NORMAL_MAP_TANGENTSPACE;
else if (typePair.first == "normal_map_tangent_space")
this->dataPtr->shader = ShaderType::NORMAL_MAP_TANGENTSPACE;
else
// Load the shader information
if (_sdf->HasElement("shader"))
{
errors.push_back({ErrorCode::ELEMENT_INVALID,
"The value[" + typePair.first + "] for a <shader><type> element is "
"not supported"});
sdf::ElementPtr elem = _sdf->GetElement("shader", errors);

std::pair<std::string, bool> typePair =
elem->Get<std::string>(errors, "type", "pixel");
if (typePair.first == "pixel")
this->dataPtr->shader = ShaderType::PIXEL;
else if (typePair.first == "vertex")
this->dataPtr->shader = ShaderType::VERTEX;
else if (typePair.first == "normal_map_objectspace")
this->dataPtr->shader = ShaderType::NORMAL_MAP_OBJECTSPACE;
else if (typePair.first == "normal_map_object_space")
this->dataPtr->shader = ShaderType::NORMAL_MAP_OBJECTSPACE;
else if (typePair.first == "normal_map_tangentspace")
this->dataPtr->shader = ShaderType::NORMAL_MAP_TANGENTSPACE;
else if (typePair.first == "normal_map_tangent_space")
this->dataPtr->shader = ShaderType::NORMAL_MAP_TANGENTSPACE;
else
{
errors.push_back({ErrorCode::ELEMENT_INVALID,
"The value[" + typePair.first + "] for a <shader><type> element is "
"not supported"});
}

this->dataPtr->normalMap =
elem->Get<std::string>(errors, "normal_map", "").first;
if (this->dataPtr->normalMap == "__default__")
this->dataPtr->normalMap = "";

if ((this->dataPtr->shader == ShaderType::NORMAL_MAP_OBJECTSPACE ||
this->dataPtr->shader == ShaderType::NORMAL_MAP_TANGENTSPACE) &&
this->dataPtr->normalMap.empty())
{
errors.push_back({ErrorCode::ELEMENT_MISSING,
"A normal map shader type has been specified, but a normal_map has "
"not."});
}
}

this->dataPtr->normalMap =
elem->Get<std::string>(errors, "normal_map", "").first;
if (this->dataPtr->normalMap == "__default__")
this->dataPtr->normalMap = "";

if ((this->dataPtr->shader == ShaderType::NORMAL_MAP_OBJECTSPACE ||
this->dataPtr->shader == ShaderType::NORMAL_MAP_TANGENTSPACE) &&
this->dataPtr->normalMap.empty())
{
errors.push_back({ErrorCode::ELEMENT_MISSING,
"A normal map shader type has been specified, but a normal_map has "
"not."});
}
}
this->dataPtr->renderOrder = _sdf->Get<float>(errors, "render_order",
this->dataPtr->renderOrder).first;

this->dataPtr->renderOrder = _sdf->Get<float>(errors, "render_order",
this->dataPtr->renderOrder).first;
this->dataPtr->ambient = _sdf->Get<gz::math::Color>(errors, "ambient",
this->dataPtr->ambient).first;

this->dataPtr->ambient = _sdf->Get<gz::math::Color>(errors, "ambient",
this->dataPtr->ambient).first;
this->dataPtr->diffuse = _sdf->Get<gz::math::Color>(errors, "diffuse",
this->dataPtr->diffuse).first;

this->dataPtr->diffuse = _sdf->Get<gz::math::Color>(errors, "diffuse",
this->dataPtr->diffuse).first;
this->dataPtr->specular = _sdf->Get<gz::math::Color>(errors, "specular",
this->dataPtr->specular).first;

this->dataPtr->specular = _sdf->Get<gz::math::Color>(errors, "specular",
this->dataPtr->specular).first;
this->dataPtr->shininess = _sdf->Get<double>(errors, "shininess",
this->dataPtr->shininess).first;

this->dataPtr->shininess = _sdf->Get<double>(errors, "shininess",
this->dataPtr->shininess).first;
this->dataPtr->emissive = _sdf->Get<gz::math::Color>(errors, "emissive",
this->dataPtr->emissive).first;

this->dataPtr->emissive = _sdf->Get<gz::math::Color>(errors, "emissive",
this->dataPtr->emissive).first;
this->dataPtr->lighting = _sdf->Get<bool>(errors, "lighting",
this->dataPtr->lighting).first;

this->dataPtr->lighting = _sdf->Get<bool>(errors, "lighting",
this->dataPtr->lighting).first;
this->dataPtr->doubleSided = _sdf->Get<bool>(errors, "double_sided",
this->dataPtr->doubleSided).first;

this->dataPtr->doubleSided = _sdf->Get<bool>(errors, "double_sided",
this->dataPtr->doubleSided).first;
// load pbr param
if (_sdf->HasElement("pbr"))
{
this->dataPtr->pbr.emplace();
Errors pbrErrors = this->dataPtr->pbr->Load(
_sdf->GetElement("pbr", errors));
errors.insert(errors.end(), pbrErrors.begin(), pbrErrors.end());
}
}

// load pbr param
if (_sdf->HasElement("pbr"))
for (auto &err : errors)
{
this->dataPtr->pbr.emplace();
Errors pbrErrors = this->dataPtr->pbr->Load(
_sdf->GetElement("pbr", errors));
errors.insert(errors.end(), pbrErrors.begin(), pbrErrors.end());
if (!err.FilePath().has_value())
{
err.SetFilePath(this->dataPtr->filePath);
}
if (!err.LineNumber().has_value() && this->dataPtr->lineNumber.has_value())
{
err.SetLineNumber(*this->dataPtr->lineNumber);
}
}

return errors;
Expand Down Expand Up @@ -398,6 +415,18 @@ void Material::SetFilePath(const std::string &_filePath)
this->dataPtr->filePath = _filePath;
}

//////////////////////////////////////////////////
std::optional<int> Material::LineNumber() const
{
return this->dataPtr->lineNumber;
}

//////////////////////////////////////////////////
void Material::SetLineNumber(int _lineNumber)
{
this->dataPtr->lineNumber = _lineNumber;
}

/////////////////////////////////////////////////
sdf::ElementPtr Material::ToElement() const
{
Expand Down
Loading