src/OSD/OSD_DirectoryIterator.cdl

   1 -- Created on: 1992-05-18
   2 -- Created by: Stephan GARNAUD
   3 -- Copyright (c) 1992-1999 Matra Datavision
   4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 --
   6 -- This file is part of Open CASCADE Technology software library.
   7 --
   8 -- This library is free software; you can redistribute it and/or modify it under
   9 -- the terms of the GNU Lesser General Public License version 2.1 as published
  10 -- by the Free Software Foundation, with special exception defined in the file
  11 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 -- distribution for complete text of the license and disclaimer of any warranty.
  13 --
  14 -- Alternatively, this file may be used under the terms of Open CASCADE
  15 -- commercial license or contractual agreement.
  16
  17 -- Updated: J.P. TIRAULT August 1993
  18 --          All methods are static methods.
  19
  20
  21 class DirectoryIterator from OSD
  22
  23  ---Purpose: Manages a breadth-only search for sub-directories in the specified
  24  --          Path.
  25  --          There is no specific order of results.
  26
  27 uses Directory, Path, Error, AsciiString from TCollection
  28
  29 raises OSDError
  30
  31 is
  32
  33  Create returns DirectoryIterator ;
  34     ---WARNING! : This method is not implemented on Windows NT System
  35     ---Purpose: Instantiates Object as empty Iterator;
  36     ---Level: Public
  37
  38  Create (where : Path ; Mask : AsciiString) returns DirectoryIterator;
  39     ---Purpose: Instantiates Object as Iterator.
  40     --          Wild-card "*" can be used in Mask the same way it
  41     --          is used by unix shell for file names
  42     ---Level: Public
  43
  44  Destroy ( me : out );
  45         ---C++: alias ~
  46         -- Only implemented on Windows NT
  47
  48  Initialize (me : in out ; where : Path ; Mask : AsciiString) is static;
  49     ---WARNING! : This method is not implemented on Windows NT System
  50     ---Purpose: Initializes the current File Directory
  51     ---Level: Public
  52
  53  More (me : in out) returns Boolean is static;
  54     ---Purpose: Returns TRUE if other items are found while
  55     --          using the 'Tree' method.
  56     ---Level: Public
  57
  58  Next (me : in out)  is static;
  59     ---Purpose: Sets the iterator to the next item.
  60     --          Returns the item value corresponding to the current
  61     --          position of the iterator.
  62     ---Level: Public
  63
  64  Values (me : in out) returns Directory is static;
  65     ---Purpose: Returns the next item found .
  66     ---Level: Public
  67
  68  Failed (me) returns Boolean is static;
  69    ---Purpose: Returns TRUE if an error occurs
  70    ---Level: Public
  71
  72  Reset (me : in out) is static;
  73    ---Purpose: Resets error counter to zero
  74    ---Level: Public
  75
  76  Perror (me : in out)
  77    ---Purpose: Raises OSD_Error
  78    ---Level: Public
  79    raises OSDError is static;
  80
  81  Error (me) returns Integer is static;
  82    ---Purpose: Returns error number if 'Failed' is TRUE.
  83    ---Level: Public
  84
  85  fields
  86       TheIterator  : Directory;     -- The iterator item
  87       myFlag       : Integer;
  88       myMask       : AsciiString;
  89       myPlace      : AsciiString;
  90       myDescr      : Address ;      -- unused by Windows NT code
  91       myEntry      : Address ;      -- unused by Windows NT code
  92       myInit       : Integer ;      -- unused by Windows NT code
  93       myError      : Error;
  94       myHandle     : Address;   -- Windows NT specific
  95       myData       : Address;   -- Windows NT specific
  96       myFirstCall  : Boolean;   -- Windows NT specific
  97 end DirectoryIterator from OSD;