third_party/txt/src/txt/paragraph_builder.h

/*
 * Copyright 2017 Google Inc.
 *
 * 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 LIB_TXT_SRC_PARAGRAPH_BUILDER_H_
#define LIB_TXT_SRC_PARAGRAPH_BUILDER_H_

#include <memory>
#include <string>

#include "flutter/fml/macros.h"
#include "font_collection.h"
#include "paragraph.h"
#include "paragraph_style.h"
#include "placeholder_run.h"
#include "text_style.h"

namespace txt {

class ParagraphBuilder {
 public:
  static std::unique_ptr<ParagraphBuilder> CreateTxtBuilder(
      const ParagraphStyle& style,
      std::shared_ptr<FontCollection> font_collection);

#if FLUTTER_ENABLE_SKSHAPER
  static std::unique_ptr<ParagraphBuilder> CreateSkiaBuilder(
      const ParagraphStyle& style,
      std::shared_ptr<FontCollection> font_collection);
#endif

  virtual ~ParagraphBuilder() = default;

  // Push a style to the stack. The corresponding text added with AddText will
  // use the top-most style.
  virtual void PushStyle(const TextStyle& style) = 0;

  // Remove a style from the stack. Useful to apply different styles to chunks
  // of text such as bolding.
  // Example:
  //   builder.PushStyle(normal_style);
  //   builder.AddText("Hello this is normal. ");
  //
  //   builder.PushStyle(bold_style);
  //   builder.AddText("And this is BOLD. ");
  //
  //   builder.Pop();
  //   builder.AddText(" Back to normal again.");
  virtual void Pop() = 0;

  // Returns the last TextStyle on the stack.
  virtual const TextStyle& PeekStyle() = 0;

  // Adds text to the builder. Forms the proper runs to use the upper-most style
  // on the style_stack_;
  virtual void AddText(const std::u16string& text) = 0;

  // Pushes the information requried to leave an open space, where Flutter may
  // draw a custom placeholder into.
  //
  // Internally, this method adds a single object replacement character (0xFFFC)
  // and emplaces a new PlaceholderRun instance to the vector of inline
  // placeholders.
  virtual void AddPlaceholder(PlaceholderRun& span) = 0;

  // Constructs a Paragraph object that can be used to layout and paint the text
  // to a SkCanvas.
  virtual std::unique_ptr<Paragraph> Build() = 0;

 protected:
  ParagraphBuilder() = default;

 private:
  FML_DISALLOW_COPY_AND_ASSIGN(ParagraphBuilder);
};

}  // namespace txt

#endif  // LIB_TXT_SRC_PARAGRAPH_BUILDER_H_