ClangFormat: apply to source, most of intern
[blender.git] / intern / cycles / util / util_path.h
index 89e4452..7a83c21 100644 (file)
@@ -1,19 +1,17 @@
 /*
- * Copyright 2011, Blender Foundation.
+ * Copyright 2011-2013 Blender Foundation
  *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
  *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * http://www.apache.org/licenses/LICENSE-2.0
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
  */
 
 #ifndef __UTIL_PATH_H__
  * linked libraries, the path to the library may be set with path_init, which
  * then makes all paths relative to that. */
 
-#include "util_string.h"
-#include "util_types.h"
-#include "util_vector.h"
+#include <stdio.h>
+
+#include "util/util_set.h"
+#include "util/util_string.h"
+#include "util/util_types.h"
+#include "util/util_vector.h"
 
 CCL_NAMESPACE_BEGIN
 
-void path_init(const string& path = "", const string& user_path = "");
-string path_get(const string& sub = "");
-string path_user_get(const string& sub = "");
+/* program paths */
+void path_init(const string &path = "", const string &user_path = "");
+string path_get(const string &sub = "");
+string path_user_get(const string &sub = "");
+string path_cache_get(const string &sub = "");
+
+/* path string manipulation */
+string path_filename(const string &path);
+string path_dirname(const string &path);
+string path_join(const string &dir, const string &file);
+string path_escape(const string &path);
+bool path_is_relative(const string &path);
+
+/* file info */
+size_t path_file_size(const string &path);
+bool path_exists(const string &path);
+bool path_is_directory(const string &path);
+string path_files_md5_hash(const string &dir);
+uint64_t path_modified_time(const string &path);
 
-string path_filename(const string& path);
-string path_dirname(const string& path);
-string path_join(const string& dir, const string& file);
+/* directory utility */
+void path_create_directories(const string &path);
 
-string path_escape(const string& path);
-bool path_exists(const string& path);
-string path_files_md5_hash(const string& dir);
+/* file read/write utilities */
+FILE *path_fopen(const string &path, const string &mode);
 
-void path_create_directories(const string& path);
-bool path_write_binary(const string& path, const vector<uint8_t>& binary);
-bool path_read_binary(const string& path, vector<uint8_t>& binary);
-bool path_read_text(const string& path, string& text);
+bool path_write_binary(const string &path, const vector<uint8_t> &binary);
+bool path_write_text(const string &path, string &text);
+bool path_read_binary(const string &path, vector<uint8_t> &binary);
+bool path_read_text(const string &path, string &text);
 
-uint64_t path_modified_time(const string& path);
+/* File manipulation. */
+bool path_remove(const string &path);
 
-string path_source_replace_includes(const string& source, const string& path);
+/* source code utility */
+string path_source_replace_includes(const string &source,
+                                    const string &path,
+                                    const string &source_filename = "");
+
+/* cache utility */
+void path_cache_clear_except(const string &name, const set<string> &except);
 
 CCL_NAMESPACE_END
 
 #endif
-