layout/generic/nsIFrameUtil.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 /* utilities for regression tests based on frame tree comparison */
   7
   8 #ifndef nsIFrameUtil_h___
   9 #define nsIFrameUtil_h___
  10
  11 #include <stdio.h>
  12 #include "nsISupports.h"
  13
  14 /* a6cf90d4-15b3-11d2-932e-00805f8add32 */
  15 #define NS_IFRAME_UTIL_IID \
  16  { 0xa6cf90d6, 0x15b3, 0x11d2,{0x93, 0x2e, 0x00, 0x80, 0x5f, 0x8a, 0xdd, 0x32}}
  17
  18 /**
  19  * Frame utility interface
  20  */
  21 class nsIFrameUtil : public nsISupports {
  22 public:
  23   NS_DECLARE_STATIC_IID_ACCESSOR(NS_IFRAME_UTIL_IID)
  24   /**
  25    * Compare two regression data dumps. The return status will be NS_OK
  26    * if the trees compare favoribly, otherwise the return will indicate
  27    * NS_ERROR_FAILURE. Other return status's will indicate some other
  28    * type of failure. The files, aFile1 and aFile2 are closed before
  29    * returning.
  30    * aRegressionOutput will vary output, 0 is full output, 1 is brief
  31    */
  32   NS_IMETHOD CompareRegressionData(FILE* aFile1, FILE* aFile2,int32_t aRegressionOutput) = 0;
  33
  34   /**
  35    * Display the regression dump data stored in aInputFile1 to
  36    * aOutputFile . The file is closed before returning. If the
  37    * regression data is in error somehow then NS_ERROR_FAILURE will be
  38    * returned.
  39    */
  40   NS_IMETHOD DumpRegressionData(FILE* aInputFile, FILE* aOutputFile) = 0;
  41 };
  42
  43 NS_DEFINE_STATIC_IID_ACCESSOR(nsIFrameUtil, NS_IFRAME_UTIL_IID)
  44
  45 #endif /* nsIFrameUtil_h___ */