llvm-project/llvm/tools/llvm-remarkutil/RemarkUtilRegistry.h
Zain Jaffal 30d8e0837d [RemarkUtil] Refactor remarkutil tool to use a command registry.
In preperation to move all remark utilities into one tool. We use
command registry to breakdown each utility into a separate file.

For now we have 3 utilities for remarks
1. Convert: which is responsible for converting yaml remarks to
   bitstream and vice-versa
2. Count: Analyse remarks and report count. This currently only supports
   asm-remarks and annotation-summary remarks.
3. Diff remarks: Currently we only have a diff for size remarks using
   `llvm-remark-size-diff`

The first two utilites have been simplified and seperated into two
files. The following commit will move `llvm-remark-size-diff` and fold
it to be inside `llvm-remarkutil` as a subcommand

Differential Revision: https://reviews.llvm.org/D156416
2023-07-28 09:21:29 +01:00

41 lines
1.3 KiB
C++

//===- RemarkUtilRegistry.h: Implement a command registry. ----------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// Implement a simple subcommand registry.
//
//===----------------------------------------------------------------------===//
#ifndef TOOLS_LLVM_REMARKUTIL_REGISTRY_H
#define TOOLS_LLVM_REMARKUTIL_REGISTRY_H
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/Error.h"
namespace llvm {
namespace remarkutil {
// Use |CommandRegistration| as a global initialiser that registers a function
// and associates it with |SC|. This requires that a command has not been
// registered to a given |SC|.
//
// Usage:
//
// // At namespace scope.
// static CommandRegistration Unused(&MySubCommand, [] { ... });
//
struct CommandRegistration {
CommandRegistration(cl::SubCommand *SC, std::function<Error()> Command);
};
// Requires that |SC| is not null and has an associated function to it.
std::function<Error()> dispatch(cl::SubCommand *SC);
} // namespace remarkutil
} // namespace llvm
#endif // TOOLS_LLVM_REMARKUTIL_REGISTRY_H