err.no Git - sope/blob - sope-core/NGExtensions/NGExtensions/NGResourceLocator.h

   1 /*
   2   Copyright (C) 2004-2005 SKYRIX Software AG
   3
   4   This file is part of SOPE.
   5
   6   SOPE is free software; you can redistribute it and/or modify it under
   7   the terms of the GNU Lesser General Public License as published by the
   8   Free Software Foundation; either version 2, or (at your option) any
   9   later version.
  10
  11   SOPE is distributed in the hope that it will be useful, but WITHOUT ANY
  12   WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
  14   License for more details.
  15
  16   You should have received a copy of the GNU Lesser General Public
  17   License along with SOPE; see the file COPYING.  If not, write to the
  18   Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  19   02111-1307, USA.
  20 */
  21
  22 #ifndef __NGExtensions_NGResourceLocator_H__
  23 #define __NGExtensions_NGResourceLocator_H__
  24
  25 #import <Foundation/NSObject.h>
  26
  27 /*
  28   NGResourceLocator
  29
  30   This class can be used by libraries to lookup resources in either the GNUstep
  31   hierarchy or in FHS locations (/usr/local etc).
  32
  33   The pathes given in are relative to the respective root, eg: "Library/Models"
  34   and "share/mytool/models".
  35 */
  36
  37 @class NSString, NSArray, NSFileManager, NSMutableDictionary;
  38
  39 @interface NGResourceLocator : NSObject
  40 {
  41   NSString      *gsSubPath;
  42   NSString      *fhsSubPath;
  43   NSFileManager *fileManager;
  44
  45   NSArray             *searchPathes;
  46   NSMutableDictionary *nameToPathCache;
  47
  48   struct {
  49     int cacheSearchPathes:1;
  50     int cachePathHits:1;
  51     int cachePathMisses:1;
  52     int reserved:29;
  53   } flags;
  54 }
  55
  56 + (id)resourceLocatorForGNUstepPath:(NSString *)_path fhsPath:(NSString *)_fhs;
  57 - (id)initWithGNUstepPath:(NSString *)_path fhsPath:(NSString *)_fhs;
  58
  59 /* resource pathes */
  60
  61 - (NSArray *)gsRootPathes;  /* GNUSTEP_PATHPREFIX_LIST or MacOSX */
  62 - (NSArray *)fhsRootPathes;
  63 - (NSArray *)searchPathes;
  64
  65 /* operations */
  66
  67 - (NSString *)lookupFileWithName:(NSString *)_name;
  68 - (NSString *)lookupFileWithName:(NSString *)_name extension:(NSString *)_ext;
  69
  70 @end
  71
  72 #endif /* __NGExtensions_NGResourceLocator_H__ */