commonMain.org.luaj.vm2.lib.ResourceFinder.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of luak-jvm Show documentation

LUAK - Kotlin port of LuaJ (fork of https://github.com/korlibs/korge-luak)

There is a newer version: 1.0.0-alpha3

/*******************************************************************************
 * Copyright (c) 2009-2011 Luaj.org. All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.luaj.vm2.lib

import org.luaj.vm2.*
import org.luaj.vm2.io.*

/**
 * Interface for opening application resource files such as scripts sources.
 *
 *
 * This is used by required to load files that are part of
 * the application, and implemented by BaseLib
 * for both the Jme and Jse platforms.
 *
 *
 * The Jme version of base lib [BaseLib]
 * implements [Globals.finder] via [Class.getResourceAsStream],
 * while the Jse version [org.luaj.vm2.lib.jse.JseBaseLib] implements it using [java.io.File.File].
 *
 *
 * The io library does not use this API for file manipulation.
 *
 *
 * @see BaseLib
 *
 * @see Globals.finder
 *
 * @see org.luaj.vm2.lib.jse.JseBaseLib
 *
 * @see org.luaj.vm2.lib.jme.JmePlatform
 *
 * @see org.luaj.vm2.lib.jse.JsePlatform
 */
interface ResourceFinder {

    /**
     * Try to open a file, or return null if not found.
     *
     * @see BaseLib
     *
     * @see org.luaj.vm2.lib.jse.JseBaseLib
     *
     *
     * @param filename
     * @return InputStream, or null if not found.
     */
    fun findResource(filename: String): LuaBinInput?
}