@eclipse-cdt-cloud/clangd-contexts/lib/util/file-util.d.ts

CDT.cloud - Support for multiple configuration contexts in clangd.

/********************************************************************************
 * Copyright (c) 2021 STMicroelectronics and others.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the Eclipse
 * Public License v. 2.0 are satisfied: GNU General Public License, version 2
 * with the GNU Classpath Exception which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 *******************************************************************************/
/**
 * Queries whether a given `path` represents a file.
 *
 * @param path a path to test
 * @returns `true` if the `path` is a file, `false` otherwise
 */
export declare function isFile(path: string): boolean;
/**
 * Queries whether a given `path` represents a directory.
 *
 * @param path a path to test
 * @returns `true` if the `path` is a directory, `false` otherwise
 */
export declare function isDirectory(path: string): boolean;
/**
 * Resolve a path to a _clangd_ configuration file.
 *
 * @param filePath a path that may or may not already identify a `.clangd` file
 * @returns the `filePath` if it is a `.clangd` file, otherwise a path that resolves a `.clangd` file as
 * a child or sibling of the `filePath` according to whether it is a directory or file, respectively
 */
export declare function toConfigPath(filePath: string): string;
/**
 * Obtain a uniform representation of a `path` regardless of host platform. This should only be used for relative paths
 * (so not involving drive letters on Windows platform) to obtain an identifier or name used for some
 * other purpose than accessing the filesystem.
 *
 * @param path a path in the host filesystem
 * @returns a representation of the `path` using `/` to separate segments
 */
export declare function toPortablePath(path: string): string;
//# sourceMappingURL=file-util.d.ts.map