DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Mercurial (1aeaa33a64f9)

VCS Links

Line Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef nsForwardReference_h__
#define nsForwardReference_h__

class nsForwardReference {
 protected:
  nsForwardReference() {}

 public:
  virtual ~nsForwardReference() {}

  /**
   * Priority codes returned from GetPhase()
   */
  enum Phase {
    /** A dummy marker, used to indicate unstarted resolution */
    eStart,

    /** The initial pass, after which the content model will be
        fully built */
    eConstruction,

    /** A second pass, after which all 'magic attribute' hookup
        will have been performed */
    eHookup,

    /** A dummy marker, used in kPasses to indicate termination */
    eDone
  };

  /**
   * Forward references are categorized by 'priority', and all
   * forward references in a higher priority are resolved before any
   * reference in a lower priority. This variable specifies this
   * ordering. The last Priority is guaranteed to be eDone.
   */
  static const Phase kPasses[];

  /**
   * Get the state in which the forward reference should be resolved.
   * 'eConstruction' references are all resolved before 'eHookup' references
   * are resolved.
   *
   * @return the Phase in which the reference needs to be resolved
   */
  virtual Phase GetPhase() = 0;

  /**
   * Result codes returned from Resolve()
   */
  enum Result {
    /** Resolution succeeded, I'm done. */
    eResolve_Succeeded,

    /** Couldn't resolve, but try me later. */
    eResolve_Later,

    /** Something bad happened, don't try again. */
    eResolve_Error
  };

  /**
   * Attempt to resolve the forward reference.
   *
   * @return a Result that tells the resolver how to treat
   * the reference.
   */
  virtual Result Resolve() = 0;
};

#endif  // nsForwardReference_h__