kythe.io@v0.0.68-0.20240422202219-7225dbc01741/kythe/cxx/indexer/proto/indexer_frontend.h (about)

     1  /*
     2   * Copyright 2018 The Kythe Authors. All rights reserved.
     3   *
     4   * Licensed under the Apache License, Version 2.0 (the "License");
     5   * you may not use this file except in compliance with the License.
     6   * You may obtain a copy of the License at
     7   *
     8   *   http://www.apache.org/licenses/LICENSE-2.0
     9   *
    10   * Unless required by applicable law or agreed to in writing, software
    11   * distributed under the License is distributed on an "AS IS" BASIS,
    12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13   * See the License for the specific language governing permissions and
    14   * limitations under the License.
    15   */
    16  
    17  #ifndef KYTHE_CXX_INDEXER_PROTO_INDEXER_FRONTEND_H_
    18  #define KYTHE_CXX_INDEXER_PROTO_INDEXER_FRONTEND_H_
    19  
    20  #include <string>
    21  #include <vector>
    22  
    23  #include "kythe/cxx/common/indexing/KytheOutputStream.h"
    24  
    25  namespace kythe {
    26  namespace proto {
    27  class CompilationUnit;
    28  class FileData;
    29  }  // namespace proto
    30  
    31  // Indexes `unit`, reading file paths and content from `files` and writing
    32  // Kythe artifacts to `output`. Returns an empty string if OK; otherwise,
    33  // an error description.
    34  std::string IndexProtoCompilationUnit(const proto::CompilationUnit& unit,
    35                                        const std::vector<proto::FileData>& files,
    36                                        KytheOutputStream* output);
    37  
    38  }  // namespace kythe
    39  
    40  #endif  // KYTHE_CXX_INDEXER_PROTO_INDEXER_FRONTEND_H_