common/source_location.h

/*
 * Copyright 2021 Google LLC
 *
 * 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 COMMON_SOURCE_LOCATION_H_
#define COMMON_SOURCE_LOCATION_H_

#include <string>
#include <vector>

#include "absl/strings/str_cat.h"
#include "absl/strings/str_split.h"

namespace cloud_kms {

// Class representing a specific location in the source code of a program.
//
// TODO(b/270419822): Drop this util in favor of std::source_location once we
// update the repo to C++20.
class SourceLocation {
 public:
  constexpr SourceLocation(uint32_t line, const char* file_name)
      : line_(line), file_name_(file_name) {}

  uint32_t line() const { return line_; }
  std::string file_name() const { return file_name_; }

  std::string ToString() const {
    std::vector<std::string> path_elems = absl::StrSplit(file_name_, '/');
    return absl::StrCat(path_elems.back(), ":", line_);
  }

 private:
  const uint32_t line_;
  const char* file_name_;
};

}  // namespace cloud_kms

// A macro for retrieving a SourceLocation object containing the curent file
// path and line number.
#define SOURCE_LOCATION ::cloud_kms::SourceLocation(__LINE__, __FILE__)

#endif  // COMMON_SOURCE_LOCATION_H_