layout/generic/nsIFrameUtil.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is Mozilla Communicator client code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 /* utilities for regression tests based on frame tree comparison */
  39
  40 #ifndef nsIFrameUtil_h___
  41 #define nsIFrameUtil_h___
  42
  43 #include <stdio.h>
  44 #include "nsISupports.h"
  45
  46 /* a6cf90d4-15b3-11d2-932e-00805f8add32 */
  47 #define NS_IFRAME_UTIL_IID \
  48  { 0xa6cf90d6, 0x15b3, 0x11d2,{0x93, 0x2e, 0x00, 0x80, 0x5f, 0x8a, 0xdd, 0x32}}
  49
  50 /**
  51  * Frame utility interface
  52  */
  53 class nsIFrameUtil : public nsISupports {
  54 public:
  55   NS_DECLARE_STATIC_IID_ACCESSOR(NS_IFRAME_UTIL_IID)
  56   /**
  57    * Compare two regression data dumps. The return status will be NS_OK
  58    * if the trees compare favoribly, otherwise the return will indicate
  59    * NS_ERROR_FAILURE. Other return status's will indicate some other
  60    * type of failure. The files, aFile1 and aFile2 are closed before
  61    * returning.
  62    * aRegressionOutput will vary output, 0 is full output, 1 is brief
  63    */
  64   NS_IMETHOD CompareRegressionData(FILE* aFile1, FILE* aFile2,PRInt32 aRegressionOuput) = 0;
  65
  66   /**
  67    * Display the regression dump data stored in aInputFile1 to
  68    * aOutputFile . The file is closed before returning. If the
  69    * regression data is in error somehow then NS_ERROR_FAILURE will be
  70    * returned.
  71    */
  72   NS_IMETHOD DumpRegressionData(FILE* aInputFile, FILE* aOutputFile) = 0;
  73 };
  74
  75 NS_DEFINE_STATIC_IID_ACCESSOR(nsIFrameUtil, NS_IFRAME_UTIL_IID)
  76
  77 #endif /* nsIFrameUtil_h___ */