// Copyright 2014 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef PPAPI_C_PRIVATE_PPP_PDF_H_
#define PPAPI_C_PRIVATE_PPP_PDF_H_

#include <stdint.h>

#include "ppapi/c/dev/pp_print_settings_dev.h"
#include "ppapi/c/pp_instance.h"
#include "ppapi/c/pp_point.h"
#include "ppapi/c/pp_var.h"

#define PPP_PDF_INTERFACE_1 "PPP_Pdf;1"
#define PPP_PDF_INTERFACE PPP_PDF_INTERFACE_1

typedef enum {
  // Rotates the page 90 degrees clockwise from its current orientation.
  PP_PRIVATEPAGETRANSFORMTYPE_ROTATE_90_CW,
  // Rotates the page 90 degrees counterclockwise from its current orientation.
  PP_PRIVATEPAGETRANSFORMTYPE_ROTATE_90_CCW
} PP_PrivatePageTransformType;
PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_PrivatePageTransformType, 4);

typedef enum {
  PP_PRIVATEDUPLEXMODE_NONE = 0,
  PP_PRIVATEDUPLEXMODE_SIMPLEX = 1,
  PP_PRIVATEDUPLEXMODE_SHORT_EDGE = 2,
  PP_PRIVATEDUPLEXMODE_LONG_EDGE = 3,
  PP_PRIVATEDUPLEXMODE_LAST = PP_PRIVATEDUPLEXMODE_LONG_EDGE
} PP_PrivateDuplexMode_Dev;
PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_PrivateDuplexMode_Dev, 4);

struct PP_PdfPrintPresetOptions_Dev {
  // Returns whether scaling is disabled. Returns same information as the
  // PPP_Printing_Dev's method IsScalingDiabled().
  PP_Bool is_scaling_disabled;

  // Number of copies to be printed.
  int32_t copies;

  // DuplexMode to be used for printing.
  PP_PrivateDuplexMode_Dev duplex;

  // True if all the pages in the PDF are the same size.
  PP_Bool is_page_size_uniform;

  // Only valid if |is_page_size_uniform| is true. The page size.
  PP_Size uniform_page_size;
};
PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES(PP_PdfPrintPresetOptions_Dev, 24);

struct PP_PdfPrintSettings_Dev {
  // Used for N-up mode.
  uint32_t pages_per_sheet;

  // The scale factor percentage, where 100 indicates default scaling.
  uint32_t scale_factor;
};
PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES(PP_PdfPrintSettings_Dev, 8);

typedef enum {
  // No action specified, default value.
  PP_PDF_ACTION_NONE = 0,
  // Action specifying a command to scroll the rect into viewport.
  PP_PDF_SCROLL_TO_MAKE_VISIBLE = 1,
  // Invokes default action on a node.
  PP_PDF_DO_DEFAULT_ACTION = 2,
  // Action specifying a command to scroll to the global point.
  PP_PDF_SCROLL_TO_GLOBAL_POINT = 3,
  // Sets text selection.
  PP_PDF_SET_SELECTION = 4,
  // Last enum value marker.
  PP_PDF_ACCESSIBILITYACTION_LAST = PP_PDF_SET_SELECTION
} PP_PdfAccessibilityAction;
PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_PdfAccessibilityAction, 4);

typedef enum {
  // No scroll alignment specified.
  PP_PDF_SCROLL_NONE = 0,
  // Scroll the point to the center of the viewport.
  PP_PDF_SCROLL_ALIGNMENT_CENTER,
  // Scroll the point to the top of the viewport.
  PP_PDF_SCROLL_ALIGNMENT_TOP,
  // Scroll the point to the bottom of the viewport.
  PP_PDF_SCROLL_ALIGNMENT_BOTTOM,
  // Scroll the point to the left of the viewport.
  PP_PDF_SCROLL_ALIGNMENT_LEFT,
  // Scroll the point to the right of the viewport.
  PP_PDF_SCROLL_ALIGNMENT_RIGHT,
  // Scroll the point to the closest edge of the viewport.
  PP_PDF_SCROLL_ALIGNMENT_CLOSEST_EDGE,
  // Last enum value marker.
  PP_PDF_ACCESSIBILITYSCROLLALIGNMENT_LAST =
      PP_PDF_SCROLL_ALIGNMENT_CLOSEST_EDGE
} PP_PdfAccessibilityScrollAlignment;
PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_PdfAccessibilityScrollAlignment, 4);

typedef enum {
  // No annotation type defined.
  PP_PDF_TYPE_NONE = 0,
  // Link annotation.
  PP_PDF_LINK = 1,
  // Last enum value marker.
  PP_PDF_ACCESSIBILITY_ANNOTATIONTYPE_LAST = PP_PDF_LINK
} PP_PdfAccessibilityAnnotationType;
PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_PdfAccessibilityAnnotationType, 4);

struct PP_PdfPageCharacterIndex {
  // Index of PDF page.
  uint32_t page_index;
  // Character index within the PDF page.
  uint32_t char_index;
};
PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_PdfPageCharacterIndex, 8);

struct PP_PdfAccessibilityActionData {
  // Accessibility action type.
  PP_PdfAccessibilityAction action;
  // Annotation type on which the action is to be performed.
  PP_PdfAccessibilityAnnotationType annotation_type;
  // Target point on which the action is to be performed.
  struct PP_Point target_point;
  // Target rect on which the action is to be performed.
  struct PP_Rect target_rect;
  // Index of annotation in page.
  uint32_t annotation_index;
  // Page index on which the link is present.
  uint32_t page_index;
  // Horizontal scroll alignment with respect to the viewport
  PP_PdfAccessibilityScrollAlignment horizontal_scroll_alignment;
  // Vertical scroll alignment with respect to the viewport
  PP_PdfAccessibilityScrollAlignment vertical_scroll_alignment;
  // Page and character index of start of selection.
  PP_PdfPageCharacterIndex selection_start_index;
  // Page and character index of exclusive end of selection.
  PP_PdfPageCharacterIndex selection_end_index;
};
PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES(PP_PdfAccessibilityActionData, 64);

struct PPP_Pdf_1_1 {
  // Returns an absolute URL if the position is over a link.
  PP_Var (*GetLinkAtPosition)(PP_Instance instance,
                              PP_Point point);

  // Requests that the plugin apply the given transform to its view.
  void (*Transform)(PP_Instance instance, PP_PrivatePageTransformType type);

  // Return true if print preset options are updated from document.
  PP_Bool (*GetPrintPresetOptionsFromDocument)(
      PP_Instance instance,
      PP_PdfPrintPresetOptions_Dev* options);

  void (*EnableAccessibility)(PP_Instance instance);

  void (*SetCaretPosition)(PP_Instance instance,
                           const struct PP_FloatPoint* position);
  void (*MoveRangeSelectionExtent)(PP_Instance instance,
                                   const struct PP_FloatPoint* extent);
  void (*SetSelectionBounds)(PP_Instance instance,
                             const struct PP_FloatPoint* base,
                             const struct PP_FloatPoint* extent);

  // Return true if plugin text can be edited. i.e. When focus is within an
  // editable form text area (a form text field or user-editable form combobox
  // text field.
  PP_Bool (*CanEditText)(PP_Instance instance);

  // Return true if plugin has editable text. i.e. When the focused editable
  // field has content.
  PP_Bool (*HasEditableText)(PP_Instance instance);

  // Replace the plugin's selected text (if focus is in an editable text area).
  // If there is no selected text, append the replacement text after the current
  // caret position.
  void (*ReplaceSelection)(PP_Instance instance, const char* text);

  // Return true if plugin can perform an undo operation.
  PP_Bool (*CanUndo)(PP_Instance instance);

  // Return true if plugin can perform a redo operation.
  PP_Bool (*CanRedo)(PP_Instance instance);

  // Perform an undo operation.
  void (*Undo)(PP_Instance instance);

  // Perform a redo operation.
  void (*Redo)(PP_Instance instance);

  // Enables PDF to respond to Accessibility Actions.
  void (*HandleAccessibilityAction)(
      PP_Instance instance,
      const PP_PdfAccessibilityActionData& action_data);

  // This is a specialized version of PPP_Printing_Dev's Begin method.
  // It functions in the same way, but takes an additional |pdf_print_settings|
  // parameter. When the PPP_Pdf interface is available, use this instead of
  // PPP_Printing_Dev's Begin method, in conjuction with PPP_Printing_Dev's
  // other methods.
  int32_t (*PrintBegin)(
      PP_Instance instance,
      const struct PP_PrintSettings_Dev* print_settings,
      const struct PP_PdfPrintSettings_Dev* pdf_print_settings);
};

typedef PPP_Pdf_1_1 PPP_Pdf;

#endif  // PPAPI_C_PRIVATE_PPP_PDF_H_