ConversionAmbiguities.hpp

/*
 * Open Chinese Convert
 *
 * Copyright 2010-2026 Carbo Kuo and contributors
 *
 * 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.
 */
 
#pragma once
 
#include <memory>
#include <string>
#include <string_view>
#include <vector>
 
#include "Common.hpp"
#include "Converter.hpp"
#include "Export.hpp"
#include "StreamWindow.hpp"
 
namespace opencc {

struct AmbiguousSpan {
  size_t outputOffset;
  size_t outputLength;
  size_t sourceIndex;
};

struct AnnotatedConversion {
  std::string output;
  std::vector<std::string> sources;
  std::vector<AmbiguousSpan> ambiguities;
  bool analyzed = true;
};

OPENCC_EXPORT AnnotatedConversion
ConvertWithAmbiguities(const Converter& converter, std::string_view text);

class OPENCC_EXPORT AmbiguityStream {
public:
  struct Chunk {
    std::string output;
    std::vector<AmbiguousSpan> ambiguities;
    std::vector<std::string> newSources;
    bool analyzed = true;
  };
 
  explicit AmbiguityStream(
      ConverterPtr converter,
      size_t maxKeepChars = internal::kDefaultStreamKeepChars);
  ~AmbiguityStream();

  Chunk ConvertChunk(std::string_view input);

  Chunk Finish(std::string_view input);

  Chunk Finish();

  size_t SourceCount() const;
 
private:
  Chunk ConvertWindow(std::string_view window);
 
  class Impl;
  std::unique_ptr<Impl> impl;
};
 
} // namespace opencc