comment.h

// Copyright 2011-2024 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
//
//     https://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 COMMENTS_H_
#define COMMENTS_H_

#include <string>
#include <utility>

#include "third_party/absl/container/btree_map.h"
#include "third_party/zynamics/binexport/comment.h"
#include "third_party/zynamics/binexport/util/types.h"

namespace security::bindiff {

struct Comment : public BasicComment {
 public:
  std::string comment;

  // Whether the comment is propagated to all locations that reference the
  // original location.
  bool repeatable = false;

  Type type = REGULAR;
};

using OperatorId = std::pair<Address, int>;
using CommentsByOperatorId = absl::btree_map<OperatorId, Comment>;

}  // namespace security::bindiff

#endif  // COMMENTS_H_