Move engine/engine_resource.{c,h} to user/user_resource.{c,h}.

PiperOrigin-RevId: 649628768 Change-Id: Id90c983cf70c0f92c3b033ac1b1654c53696955d
2024-07-05 05:40:58 -07:00
parent d029e4ff99
commit c6fd002f87
15 changed files with 18 additions and 16 deletions
@@ -0,0 +1,58 @@
+// Copyright 2022 DeepMind Technologies Limited
+//
+// 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
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// 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.
+// IWYU pragma: private, include "third_party/mujoco/include/mujoco.h"
+// IWYU pragma: friend "third_party/mujoco/src/.*"
+
+#ifndef MUJOCO_SRC_ENGINE_ENGINE_RESOURCE_H_
+#define MUJOCO_SRC_ENGINE_ENGINE_RESOURCE_H_
+
+#include <stddef.h>
+
+#include <mujoco/mjexport.h>
+#include <mujoco/mujoco.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+// open the given resource; if the name doesn't have a prefix matching with a
+// resource provider, then the OS filesystem is used
+MJAPI mjResource* mju_openResource(const char* name, char* error, size_t error_sz);
+
+// close the given resource; no-op if resource is NULL
+MJAPI void mju_closeResource(mjResource* resource);
+
+// set buffer to bytes read from the resource and return number of bytes in buffer;
+// return negative value if error
+MJAPI int mju_readResource(mjResource* resource, const void** buffer);
+
+// set for a resource with a name partitioned as {dir}{filename}, the dir and ndir pointers
+MJAPI void mju_getResourceDir(mjResource* resource, const char** dir, int* ndir);
+
+// return 0 if the resource's timestamp matches the provided timestamp
+// return > 0 if the the resource is younger than the given timestamp
+// return < 0 if the resource is older than the given timestamp
+MJAPI int mju_isModifiedResource(const mjResource* resource, const char* timestamp);
+
+// get the length of the dirname portion of a given path
+int mju_dirnamelen(const char* path);
+
+// read file into memory buffer (allocated here with mju_malloc)
+void* mju_fileToMemory(const char* filename, size_t* filesize);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif  // MUJOCO_SRC_ENGINE_ENGINE_RESOURCE_H_