verilog/CST/class.h

// Copyright 2017-2020 The Verible Authors.
//
// 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.

// This unit provides helper functions that pertain to SystemVerilog
// class declaration nodes in the parser-generated concrete syntax tree.

#ifndef VERIBLE_VERILOG_CST_CLASS_H_
#define VERIBLE_VERILOG_CST_CLASS_H_

#include "common/analysis/syntax_tree_search.h"
#include "common/text/concrete_syntax_tree.h"

namespace verilog {

// Find all class declarations.
std::vector<verible::TreeSearchMatch> FindAllClassDeclarations(
    const verible::Symbol&);

// Returns the full header of a class.
const verible::SyntaxTreeNode& GetClassHeader(const verible::Symbol&);

// Returns the leaf node for class name.
const verible::SyntaxTreeLeaf& GetClassName(const verible::Symbol&);

// Returns class name token after endclass.
// e.g. from "class foo; endclass: foo" returns the second "foo".
const verible::SyntaxTreeLeaf* GetClassEndLabel(const verible::Symbol&);

// Returns the node spanning class's Item list.
const verible::SyntaxTreeNode& GetClassItemList(const verible::Symbol&);

}  // namespace verilog

#endif  // VERIBLE_VERILOG_CST_CLASS_H_