metaforce/hecl/driver/ToolCook.hpp

161 lines
7.1 KiB
C++
Raw Normal View History

2018-10-07 03:38:44 +00:00
#pragma once
2015-06-10 02:40:03 +00:00
#include "ToolBase.hpp"
2017-12-29 07:56:31 +00:00
#include <cstdio>
2017-10-25 07:46:32 +00:00
#include "hecl/ClientProcess.hpp"
2015-06-10 02:40:03 +00:00
2018-12-08 05:18:42 +00:00
class ToolCook final : public ToolBase {
std::vector<hecl::ProjectPath> m_selectedItems;
std::unique_ptr<hecl::Database::Project> m_fallbackProj;
hecl::Database::Project* m_useProj;
const hecl::Database::DataSpecEntry* m_spec = nullptr;
bool m_recursive = false;
bool m_fast = false;
2015-10-16 00:34:47 +00:00
2018-12-08 05:18:42 +00:00
public:
ToolCook(const ToolPassInfo& info) : ToolBase(info), m_useProj(info.project) {
/* Check for recursive flag */
for (hecl::SystemChar arg : info.flags)
if (arg == _SYS_STR('r'))
m_recursive = true;
2015-10-22 02:01:08 +00:00
2018-12-08 05:18:42 +00:00
/* Scan args */
if (info.args.size()) {
/* See if project path is supplied via args and use that over the getcwd one */
m_selectedItems.reserve(info.args.size());
for (const hecl::SystemString& arg : info.args) {
if (arg.empty())
continue;
else if (!arg.compare(_SYS_STR("--fast"))) {
m_fast = true;
continue;
} else if (arg.size() >= 8 && !arg.compare(0, 7, _SYS_STR("--spec="))) {
hecl::SystemString specName(arg.begin() + 7, arg.end());
for (const hecl::Database::DataSpecEntry* spec : hecl::Database::DATA_SPEC_REGISTRY) {
if (!hecl::StrCaseCmp(spec->m_name.data(), specName.c_str())) {
m_spec = spec;
break;
2015-09-30 06:23:07 +00:00
}
2018-12-08 05:18:42 +00:00
}
if (!m_spec)
2019-07-28 01:19:48 +00:00
LogModule.report(logvisor::Fatal, fmt(_SYS_STR("unable to find data spec '{}'")), specName);
2018-12-08 05:18:42 +00:00
continue;
} else if (arg.size() >= 2 && arg[0] == _SYS_STR('-') && arg[1] == _SYS_STR('-'))
continue;
2015-06-10 02:40:03 +00:00
2018-12-08 05:18:42 +00:00
hecl::SystemString subPath;
hecl::ProjectRootPath root = hecl::SearchForProject(MakePathArgAbsolute(arg, info.cwd), subPath);
if (root) {
if (!m_fallbackProj) {
m_fallbackProj.reset(new hecl::Database::Project(root));
m_useProj = m_fallbackProj.get();
} else if (m_fallbackProj->getProjectRootPath() != root)
LogModule.report(logvisor::Fatal,
2019-07-20 04:22:58 +00:00
fmt(_SYS_STR("hecl cook can only process multiple items in the same project; ")
_SYS_STR("'{}' and '{}' are different projects")),
m_fallbackProj->getProjectRootPath().getAbsolutePath(),
root.getAbsolutePath());
2018-12-08 05:18:42 +00:00
m_selectedItems.emplace_back(*m_useProj, subPath);
2015-10-04 04:35:18 +00:00
}
2018-12-08 05:18:42 +00:00
}
2015-06-10 02:40:03 +00:00
}
2018-12-08 05:18:42 +00:00
if (!m_useProj)
LogModule.report(logvisor::Fatal,
2019-07-20 04:22:58 +00:00
fmt("hecl cook must be ran within a project directory or "
"provided a path within a project"));
2015-06-10 02:40:03 +00:00
2018-12-08 05:18:42 +00:00
/* Default case: recursive at root */
if (m_selectedItems.empty()) {
m_selectedItems.reserve(1);
m_selectedItems.push_back({hecl::ProjectPath(*m_useProj, _SYS_STR(""))});
m_recursive = true;
}
}
2015-06-10 02:40:03 +00:00
2018-12-08 05:18:42 +00:00
static void Help(HelpOutput& help) {
help.secHead(_SYS_STR("NAME"));
help.beginWrap();
help.wrap(_SYS_STR("hecl-cook - Cook objects within the project database\n"));
help.endWrap();
2015-06-10 02:40:03 +00:00
2018-12-08 05:18:42 +00:00
help.secHead(_SYS_STR("SYNOPSIS"));
help.beginWrap();
help.wrap(_SYS_STR("hecl cook [-rf] [--fast] [--spec=<spec>] [<pathspec>...]\n"));
help.endWrap();
help.secHead(_SYS_STR("DESCRIPTION"));
help.beginWrap();
help.wrap(_SYS_STR("This command initiates a cooking pass on the project database. Cooking ")
2018-10-14 20:09:15 +00:00
_SYS_STR("is analogous to compiling in software development. The resulting object buffers ")
2018-12-08 05:18:42 +00:00
_SYS_STR("are cached within the project database. HECL performs the following ")
_SYS_STR("tasks for each object during the cook process:\n\n"));
help.wrapBold(_SYS_STR("- Object Gather: "));
help.wrap(_SYS_STR("Files added with "));
help.wrapBold(_SYS_STR("hecl add"));
help.wrap(_SYS_STR(" are queried for their dependent files (e.g. "));
help.wrapBold(_SYS_STR(".blend"));
help.wrap(_SYS_STR(" files return any linked "));
help.wrapBold(_SYS_STR(".png"));
help.wrap(_SYS_STR(" images). If the dependent files are unable to be found, the cook process aborts.\n\n"));
help.wrapBold(_SYS_STR("- Modtime Comparison: "));
help.wrap(_SYS_STR("Files that have previously finished a cook pass are inspected for their time of ")
_SYS_STR("last modification. If the file hasn't changed since its previous cook-pass, the ") _SYS_STR(
"process is skipped. If the file has been moved or deleted, the object is automatically ")
_SYS_STR("removed from the project database.\n\n"));
help.wrapBold(_SYS_STR("- Cook: "));
help.wrap(_SYS_STR("A type-specific procedure compiles the file's contents into an efficient format ")
2018-10-14 20:09:15 +00:00
_SYS_STR("for use by the runtime. A data-buffer is provided to HECL.\n\n"));
2018-12-08 05:18:42 +00:00
help.wrapBold(_SYS_STR("- Hash and Compress: "));
help.wrap(_SYS_STR("The data-buffer is hashed and compressed before being cached in the object database.\n\n"));
help.endWrap();
2015-06-10 02:40:03 +00:00
2018-12-08 05:18:42 +00:00
help.secHead(_SYS_STR("OPTIONS"));
help.optionHead(_SYS_STR("<pathspec>..."), _SYS_STR("input file(s)"));
help.beginWrap();
help.wrap(_SYS_STR("Specifies working file(s) containing production data to be cooked by HECL. ")
2018-10-14 20:09:15 +00:00
_SYS_STR("Glob-strings may be specified (e.g. "));
2018-12-08 05:18:42 +00:00
help.wrapBold(_SYS_STR("*.blend"));
help.wrap(_SYS_STR(") to automatically cook all matching current-directory files in the project database. ")
2018-10-14 20:09:15 +00:00
_SYS_STR("If no path specified, all files in the project database are cooked.\n"));
2018-12-08 05:18:42 +00:00
help.endWrap();
2015-06-10 02:40:03 +00:00
2018-12-08 05:18:42 +00:00
help.optionHead(_SYS_STR("-r"), _SYS_STR("recursion"));
help.beginWrap();
help.wrap(_SYS_STR("Enables recursive file-matching for cooking entire directories of working files.\n"));
help.endWrap();
help.optionHead(_SYS_STR("-f"), _SYS_STR("force"));
help.beginWrap();
help.wrap(_SYS_STR("Forces cooking of all matched files, ignoring timestamp differences.\n"));
help.endWrap();
help.optionHead(_SYS_STR("--fast"), _SYS_STR("fast cook"));
help.beginWrap();
help.wrap(_SYS_STR("Performs draft-optimization cooking for supported data types.\n"));
help.endWrap();
2018-03-23 21:40:12 +00:00
2018-12-08 05:18:42 +00:00
help.optionHead(_SYS_STR("--spec=<spec>"), _SYS_STR("data specification"));
help.beginWrap();
help.wrap(_SYS_STR("Specifies a DataSpec to use when cooking. ")
2018-10-14 20:09:15 +00:00
_SYS_STR("This build of hecl supports the following values of <spec>:\n"));
2018-12-08 05:18:42 +00:00
for (const hecl::Database::DataSpecEntry* spec : hecl::Database::DATA_SPEC_REGISTRY) {
if (!spec->m_factory)
continue;
help.wrap(_SYS_STR(" "));
help.wrapBold(spec->m_name.data());
help.wrap(_SYS_STR("\n"));
2015-06-10 02:40:03 +00:00
}
2018-12-08 05:18:42 +00:00
}
2015-06-10 02:40:03 +00:00
hecl::SystemString toolName() const override { return _SYS_STR("cook"); }
2015-06-10 02:40:03 +00:00
int run() override {
2018-12-08 05:18:42 +00:00
hecl::MultiProgressPrinter printer(true);
hecl::ClientProcess cp(&printer);
for (const hecl::ProjectPath& path : m_selectedItems)
m_useProj->cookPath(path, printer, m_recursive, m_info.force, m_fast, m_spec, &cp);
cp.waitUntilComplete();
return 0;
}
void cancel() override { m_useProj->interruptCook(); }
2015-06-10 02:40:03 +00:00
};