Sync usage with man page.
[netbsd-mini2440.git] / sys / external / intel-public / acpica / dist / os_specific / service_layers / oswindir.c
blob445813d7b79cbe2a0aee1eb287491463f036c4cd
2 /******************************************************************************
4 * Module Name: oswindir - Windows directory access interfaces
6 *****************************************************************************/
8 /******************************************************************************
10 * 1. Copyright Notice
12 * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp.
13 * All rights reserved.
15 * 2. License
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights. You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
20 * property rights.
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code. No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
38 * The above copyright and patent license is granted only if the following
39 * conditions are met:
41 * 3. Conditions
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision. In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change. Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee. Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution. In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
65 * make.
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
71 * distribution.
73 * 3.4. Intel retains all right, title, and interest in and to the Original
74 * Intel Code.
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
81 * 4. Disclaimer and Export Compliance
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
89 * PARTICULAR PURPOSE.
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
98 * LIMITED REMEDY.
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
115 *****************************************************************************/
118 #include <stdio.h>
119 #include <stdlib.h>
120 #include <string.h>
121 #include <io.h>
123 #include <acpi.h>
125 typedef struct ExternalFindInfo
127 struct _finddata_t DosInfo;
128 char *FullWildcardSpec;
129 long FindHandle;
130 char State;
131 char RequestedFileType;
133 } EXTERNAL_FIND_INFO;
136 /*******************************************************************************
138 * FUNCTION: AcpiOsOpenDirectory
140 * PARAMETERS: DirPathname - Full pathname to the directory
141 * WildcardSpec - string of the form "*.c", etc.
142 * RequestedFileType - Either a directory or normal file
144 * RETURN: A directory "handle" to be used in subsequent search operations.
145 * NULL returned on failure.
147 * DESCRIPTION: Open a directory in preparation for a wildcard search
149 ******************************************************************************/
151 void *
152 AcpiOsOpenDirectory (
153 char *DirPathname,
154 char *WildcardSpec,
155 char RequestedFileType)
157 long FindHandle;
158 char *FullWildcardSpec;
159 EXTERNAL_FIND_INFO *SearchInfo;
162 /* No directory path means "use current directory" - use a dot */
164 if (!DirPathname || strlen (DirPathname) == 0)
166 DirPathname = ".";
169 /* Allocate the info struct that will be returned to the caller */
171 SearchInfo = calloc (sizeof (EXTERNAL_FIND_INFO), 1);
172 if (!SearchInfo)
174 return NULL;
177 /* Allocate space for the full wildcard path */
179 FullWildcardSpec = calloc (strlen (DirPathname) + strlen (WildcardSpec) + 2, 1);
180 if (!FullWildcardSpec)
182 printf ("Could not allocate buffer for wildcard pathname\n");
183 return NULL;
186 /* Create the full wildcard path */
188 strcpy (FullWildcardSpec, DirPathname);
189 strcat (FullWildcardSpec, "/");
190 strcat (FullWildcardSpec, WildcardSpec);
192 /* Initialize the find functions, get first match */
194 FindHandle = _findfirst (FullWildcardSpec, &SearchInfo->DosInfo);
195 if (FindHandle == -1)
197 /* Failure means that no match was found */
199 free (FullWildcardSpec);
200 free (SearchInfo);
201 return NULL;
204 /* Save the info in the return structure */
206 SearchInfo->RequestedFileType = RequestedFileType;
207 SearchInfo->FullWildcardSpec = FullWildcardSpec;
208 SearchInfo->FindHandle = FindHandle;
209 SearchInfo->State = 0;
210 return (SearchInfo);
214 /*******************************************************************************
216 * FUNCTION: AcpiOsGetNextFilename
218 * PARAMETERS: DirHandle - Created via AcpiOsOpenDirectory
220 * RETURN: Next filename matched. NULL if no more matches.
222 * DESCRIPTION: Get the next file in the directory that matches the wildcard
223 * specification.
225 ******************************************************************************/
227 char *
228 AcpiOsGetNextFilename (
229 void *DirHandle)
231 EXTERNAL_FIND_INFO *SearchInfo = DirHandle;
232 int Status;
233 char FileTypeNotMatched = 1;
237 * Loop while we have matched files but not found any files of
238 * the requested type.
240 while (FileTypeNotMatched)
242 /* On the first call, we already have the first match */
244 if (SearchInfo->State == 0)
246 /* No longer the first match */
248 SearchInfo->State = 1;
250 else
252 /* Get the next match */
254 Status = _findnext (SearchInfo->FindHandle, &SearchInfo->DosInfo);
255 if (Status != 0)
257 return NULL;
262 * Found a match, now check to make sure that the file type
263 * matches the requested file type (directory or normal file)
265 * NOTE: use of the attrib field saves us from doing a very
266 * expensive stat() on the file!
268 switch (SearchInfo->RequestedFileType)
270 case REQUEST_FILE_ONLY:
272 /* Anything other than A_SUBDIR is OK */
274 if (!(SearchInfo->DosInfo.attrib & _A_SUBDIR))
276 FileTypeNotMatched = 0;
278 break;
280 case REQUEST_DIR_ONLY:
282 /* Must have A_SUBDIR bit set */
284 if (SearchInfo->DosInfo.attrib & _A_SUBDIR)
286 FileTypeNotMatched = 0;
288 break;
290 default:
291 return NULL;
295 return (SearchInfo->DosInfo.name);
299 /*******************************************************************************
301 * FUNCTION: AcpiOsCloseDirectory
303 * PARAMETERS: DirHandle - Created via AcpiOsOpenDirectory
305 * RETURN: None.
307 * DESCRIPTION: Close the open directory and cleanup.
309 ******************************************************************************/
311 void
312 AcpiOsCloseDirectory (
313 void *DirHandle)
315 EXTERNAL_FIND_INFO *SearchInfo = DirHandle;
318 /* Close the directory and free allocations */
320 _findclose (SearchInfo->FindHandle);
321 free (SearchInfo->FullWildcardSpec);
322 free (DirHandle);