infer_clone/infer/src/IR/Annot.rei

/*
 * Copyright (c) 2009 - 2013 Monoidics ltd.
 * Copyright (c) 2013 - present Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the BSD style license found in the
 * LICENSE file in the root directory of this source tree. An additional grant
 * of patent rights can be found in the PATENTS file in the same directory.
 */
open! IStd;


/** The Smallfoot Intermediate Language: Annotations */
module F = Format;

type parameters = list string;


/** Type to represent one @Annotation. */
type t = {
  class_name: string, /** name of the annotation */
  parameters /** currently only one string parameter */
}
[@@deriving compare];


/** annotation for fields/methods marked with the "volatile" keyword */
let volatile: t;


/** Pretty print an annotation. */
let pp: F.formatter => t => unit;

module Map: PrettyPrintable.PPMap with type key = t;

module Item: {

  /** Annotation for one item: a list of annotations with visibility. */
  type nonrec t = list (t, bool) [@@deriving compare];
  let equal: t => t => bool;

  /** Pretty print an item annotation. */
  let pp: F.formatter => t => unit;
  let to_string: t => string;

  /** Empty item annotation. */
  let empty: t;

  /** Check if the item annodation is empty. */
  let is_empty: t => bool;
};

module Class: {let objc: Item.t; let cpp: Item.t;};

module Method: {

  /** Annotation for a method: return value and list of parameters. */
  type t = (Item.t, list Item.t) [@@deriving compare];

  /** Empty method annotation. */
  let empty: t;

  /** Check if the method annodation is empty. */
  let is_empty: t => bool;

  /** Pretty print a method annotation. */
  let pp: string => F.formatter => t => unit;
};