Skip to content
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

[clang-doc] Add --asset option to clang-doc #94717

Merged
merged 20 commits into from
Jun 20, 2024
Merged

[clang-doc] Add --asset option to clang-doc #94717

Changes from 2 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
eeb3346
[clang][clang-doc] add asset path
PeterChou1 Jun 7, 2024
85581ed
[clang][clang-doc] fixes bug caused by not passing by reference
PeterChou1 Jun 7, 2024
6fee7d0
[clang][clang-doc] address pr comments about --asset option
PeterChou1 Jun 7, 2024
a846215
[clang][clang-doc] add a test case
PeterChou1 Jun 7, 2024
39e0647
[clang][clang-doc] PR comments
PeterChou1 Jun 11, 2024
94b2979
[clang][clang-doc] fix asset option
PeterChou1 Jun 11, 2024
f246098
[clang][clang-doc] address PR comments
PeterChou1 Jun 11, 2024
27bfe8d
[clang][clang-doc] address PR comments
PeterChou1 Jun 11, 2024
bacf3d8
[clang][clang-doc] address pr comments
PeterChou1 Jun 14, 2024
17024cc
[clang][clang-doc] address pr comments
PeterChou1 Jun 18, 2024
2910383
[clang][clang-doc] remove unnecessary commands
PeterChou1 Jun 18, 2024
def242a
[clang][clang-doc] rename err
PeterChou1 Jun 18, 2024
41bd204
[clang][clang-doc] rename err
PeterChou1 Jun 18, 2024
2362931
[clang][clang-doc] formatting
PeterChou1 Jun 18, 2024
3bded9e
[clang][clang-doc] remove asset error for not generating asset
PeterChou1 Jun 18, 2024
060c1a3
[clang][clang-doc] turn warning into to string
PeterChou1 Jun 18, 2024
830e1a3
[clang][clang-doc] shift messaging
PeterChou1 Jun 18, 2024
0a02116
[clang][clang-doc] accomadate for shared asset
PeterChou1 Jun 19, 2024
bf76d45
[clang][clang-doc] use path seperators
PeterChou1 Jun 19, 2024
a9c8465
[clang][clang-doc] re add path seperator
PeterChou1 Jun 20, 2024
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
74 changes: 56 additions & 18 deletions clang-tools-extra/clang-doc/tool/ClangDocMain.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,12 @@ static llvm::cl::list<std::string> UserStylesheets(
llvm::cl::desc("CSS stylesheets to extend the default styles."),
llvm::cl::cat(ClangDocCategory));

static llvm::cl::opt<std::string>
UserAssetPath("asset",
llvm::cl::desc("User supplied asset path for html output to "
"override the default css and js files"),
PeterChou1 marked this conversation as resolved.
Show resolved Hide resolved
llvm::cl::cat(ClangDocCategory));

static llvm::cl::opt<std::string> SourceRoot("source-root", llvm::cl::desc(R"(
Directory where processed files are stored.
Links to definition locations will only be
Expand Down Expand Up @@ -131,12 +137,55 @@ std::string GetExecutablePath(const char *Argv0, void *MainAddr) {
return llvm::sys::fs::getMainExecutable(Argv0, MainAddr);
}

void GetAssetFiles(clang::doc::ClangDocContext &CDCtx) {
std::error_code Code;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: I'd use Err.

There isn't a completely consistent practice in Clang-Doc code, but FileErr seems most common. https://llvm.org/docs/ProgrammersManual.html#interoperability-with-std-error-code-and-erroror has a little to say, and the Error handling section on that page may be useful, but we don't have a firm convention.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
std::error_code Code;
std::error_code Err;
Suggested change
std::error_code Code;
std::error_code FileErr;

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This still uses Code. please use a naming convention consistent w/ this tool and other parts of LLVM before marking it resolved.

for (auto DirIt = llvm::sys::fs::directory_iterator(
std::string(UserAssetPath), Code),
PeterChou1 marked this conversation as resolved.
Show resolved Hide resolved
dir_end = llvm::sys::fs::directory_iterator();
PeterChou1 marked this conversation as resolved.
Show resolved Hide resolved
!Code && DirIt != dir_end; DirIt.increment(Code)) {
llvm::SmallString<128> filePath = llvm::SmallString<128>(DirIt->path());
if (llvm::sys::fs::is_regular_file(filePath)) {
if (filePath.ends_with(".css")) {
PeterChou1 marked this conversation as resolved.
Show resolved Hide resolved
CDCtx.UserStylesheets.insert(CDCtx.UserStylesheets.begin(),
std::string(filePath));
} else if (filePath.ends_with(".js")) {
CDCtx.FilesToCopy.emplace_back(filePath.str());
}
}
}
}
ilovepi marked this conversation as resolved.
Show resolved Hide resolved

void GetDefaultAssetFiles(const char *Argv0,
clang::doc::ClangDocContext &CDCtx) {
void *MainAddr = (void *)(intptr_t)GetExecutablePath;
std::string ClangDocPath = GetExecutablePath(Argv0, MainAddr);
llvm::SmallString<128> NativeClangDocPath;
llvm::sys::path::native(ClangDocPath, NativeClangDocPath);

llvm::SmallString<128> AssetsPath;
AssetsPath = llvm::sys::path::parent_path(NativeClangDocPath);
llvm::sys::path::append(AssetsPath, "..", "share", "clang");
llvm::SmallString<128> DefaultStylesheet;
llvm::sys::path::native(AssetsPath, DefaultStylesheet);
llvm::sys::path::append(DefaultStylesheet,
"clang-doc-default-stylesheet.css");
llvm::SmallString<128> IndexJS;
llvm::sys::path::native(AssetsPath, IndexJS);
llvm::sys::path::append(IndexJS, "index.js");
ilovepi marked this conversation as resolved.
Show resolved Hide resolved
CDCtx.UserStylesheets.insert(CDCtx.UserStylesheets.begin(),
std::string(DefaultStylesheet));
CDCtx.FilesToCopy.emplace_back(IndexJS.str());

llvm::outs() << "No default asset path found using default asset path: "
<< AssetsPath << "\n";
}

int main(int argc, const char **argv) {
llvm::sys::PrintStackTraceOnErrorSignal(argv[0]);
std::error_code OK;

const char *Overview =
R"(Generates documentation from source code and comments.
R"(Generates documentation from source code and comments.

Example usage for files without flags (default):

Expand Down Expand Up @@ -182,23 +231,12 @@ Example usage for a project using a compile commands database:
{"index.js", "index_json.js"}};

if (Format == "html") {
void *MainAddr = (void *)(intptr_t)GetExecutablePath;
std::string ClangDocPath = GetExecutablePath(argv[0], MainAddr);
llvm::SmallString<128> NativeClangDocPath;
llvm::sys::path::native(ClangDocPath, NativeClangDocPath);
llvm::SmallString<128> AssetsPath;
AssetsPath = llvm::sys::path::parent_path(NativeClangDocPath);
llvm::sys::path::append(AssetsPath, "..", "share", "clang");
llvm::SmallString<128> DefaultStylesheet;
llvm::sys::path::native(AssetsPath, DefaultStylesheet);
llvm::sys::path::append(DefaultStylesheet,
"clang-doc-default-stylesheet.css");
llvm::SmallString<128> IndexJS;
llvm::sys::path::native(AssetsPath, IndexJS);
llvm::sys::path::append(IndexJS, "index.js");
CDCtx.UserStylesheets.insert(CDCtx.UserStylesheets.begin(),
std::string(DefaultStylesheet));
CDCtx.FilesToCopy.emplace_back(IndexJS.str());
if (!UserAssetPath.empty() &&
llvm::sys::fs::is_directory(std::string(UserAssetPath))) {
GetAssetFiles(CDCtx);
PeterChou1 marked this conversation as resolved.
Show resolved Hide resolved
} else {
GetDefaultAssetFiles(argv[0], CDCtx);
}
}

// Mapping phase
Expand Down
Loading