FilePath.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2006-2019 ARM Limited
00003  * SPDX-License-Identifier: Apache-2.0
00004  *
00005  * Licensed under the Apache License, Version 2.0 (the "License");
00006  * you may not use this file except in compliance with the License.
00007  * You may obtain a copy of the License at
00008  *
00009  *     http://www.apache.org/licenses/LICENSE-2.0
00010  *
00011  * Unless required by applicable law or agreed to in writing, software
00012  * distributed under the License is distributed on an "AS IS" BASIS,
00013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00014  * See the License for the specific language governing permissions and
00015  * limitations under the License.
00016  */
00017 #ifndef MBED_FILEPATH_H
00018 #define MBED_FILEPATH_H
00019 
00020 #include "platform/platform.h"
00021 
00022 #include "platform/FileSystemLike.h"
00023 #include "platform/FileLike.h"
00024 
00025 namespace mbed {
00026 
00027 class FileSystem;
00028 
00029 /**
00030  * \defgroup platform_FilePath FilePath class
00031  * \ingroup platform-public-api-file
00032  * @{
00033  */
00034 
00035 /** Class FilePath
00036  *
00037  */
00038 class FilePath {
00039 public:
00040     /** Constructor FilePath
00041      *
00042      *  @param file_path     The path of file.
00043      */
00044     FilePath(const char *file_path);
00045 
00046     const char *fileName(void);
00047 
00048     bool          isFileSystem(void);
00049     FileSystemLike *fileSystem(void);
00050 
00051     bool    isFile(void);
00052     FileLike *file(void);
00053     bool    exists(void);
00054 
00055 private:
00056     const char *file_name;
00057     FileBase *fb;
00058 };
00059 
00060 /**@}*/
00061 
00062 } // namespace mbed
00063 
00064 #endif