discover.h

Go to the documentation of this file.

/*
 * Copyright 2026 The A11 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.
 */
 
#ifndef A11_FLOW_DISCOVER_H_
#define A11_FLOW_DISCOVER_H_
 
#include <cstddef>
#include <optional>
#include <string>
#include <string_view>
#include <vector>
 
#include <absl/types/span.h>
 
#include "a11/flow/catalogue.h"
 
namespace a11::flow {
 
namespace discover {
 
using Origin = catalogue::Origin;
 
enum class Language {
  kPython,
  kCpp,
  kTypeScript,
};
 
std::optional<Language> LanguageOf(std::string_view path);
 
struct Options {
  std::vector<std::string> skip_directories;
 
  size_t max_file_bytes = 1u << 20;
 
  size_t max_files = 20000;
 
  static Options Default();
};
 
struct Result {
  catalogue::Catalogue found;
  size_t files_read = 0;
  std::vector<std::string> too_large;
  bool reached_file_limit = false;
};
 
Result Discover(absl::Span<const std::string> roots,
                const Options& options = Options::Default());
 
catalogue::Catalogue DiscoverInSource(std::string_view source,
                                      std::string_view path, Language language);
 
// The `format` field of the envelope a scan answers with, which is the
// catalogue's own: what a scan produces *is* a catalogue, and a consumer that
// had to tell them apart would be a consumer with two code paths for one.
inline constexpr std::string_view kScanFormat = catalogue::kCatalogueFormat;
 
}  // namespace discover
}  // namespace a11::flow
 
#endif  // A11_FLOW_DISCOVER_H_