modules/common-vm/src/main/java/cc/squirreljme/vm/SummerCoatJarLibrary.java

   1 // -*- Mode: Java; indent-tabs-mode: t; tab-width: 4 -*-
   2 // ---------------------------------------------------------------------------
   3 // SquirrelJME
   4 //     Copyright (C) Stephanie Gawroriski <xer@multiphasicapps.net>
   5 // ---------------------------------------------------------------------------
   6 // SquirrelJME is under the GNU General Public License v3+, or later.
   7 // See license.mkd for licensing and copyright information.
   8 // ---------------------------------------------------------------------------
   9
  10 package cc.squirreljme.vm;
  11
  12 import cc.squirreljme.runtime.cldc.annotation.Exported;
  13 import java.io.IOException;
  14 import java.io.InputStream;
  15 import java.nio.file.Files;
  16 import java.nio.file.Path;
  17 import java.nio.file.StandardOpenOption;
  18
  19 /**
  20  * Jar Library for SummerCoat.
  21  *
  22  * @since 2020/11/23
  23  */
  24 @Exported
  25 public class SummerCoatJarLibrary
  26         implements VMClassLibrary
  27 {
  28         /** Special name for SummerCoat ROM chunk. */
  29         public static final String ROM_CHUNK_RESOURCE =
  30                 "$$SQUIRRELJME$SUMMERCOAT$$";
  31
  32         /** The path to the ROM. */
  33         protected final Path path;
  34
  35         /**
  36          * Initializes the ROM library.
  37          *
  38          * @param __path The ROM path.
  39          * @throws NullPointerException On null arguments.
  40          * @since 2020/11/23
  41          */
  42         @Exported
  43         public SummerCoatJarLibrary(Path __path)
  44                 throws NullPointerException
  45         {
  46                 if (__path == null)
  47                         throw new NullPointerException("NARG");
  48
  49                 this.path = __path;
  50         }
  51
  52         /**
  53          * {@inheritDoc}
  54          * @since 2020/11/23
  55          */
  56         @Override
  57         public String[] listResources()
  58         {
  59                 // There is only ever a single resource
  60                 return new String[]{SummerCoatJarLibrary.ROM_CHUNK_RESOURCE};
  61         }
  62
  63         /**
  64          * {@inheritDoc}
  65          * @since 2020/11/23
  66          */
  67         @Override
  68         public String name()
  69         {
  70                 return this.path.getFileName().toString();
  71         }
  72
  73         /**
  74          * {@inheritDoc}
  75          * @since 2021/06/13
  76          */
  77         @Override
  78         public Path path()
  79         {
  80                 return this.path;
  81         }
  82
  83         /**
  84          * {@inheritDoc}
  85          * @since 2020/11/23
  86          */
  87         @Override
  88         public InputStream resourceAsStream(String __rc)
  89                 throws IOException, NullPointerException
  90         {
  91                 if (__rc == null)
  92                         throw new NullPointerException("NARG");
  93
  94                 // Not our ROM chunk?
  95                 if (!SummerCoatJarLibrary.ROM_CHUNK_RESOURCE.equals(__rc))
  96                         return null;
  97
  98                 return Files.newInputStream(this.path, StandardOpenOption.READ);
  99         }
 100
 101         /**
 102          * {@inheritDoc}
 103          * @since 2020/11/27
 104          */
 105         @Override
 106         public String toString()
 107         {
 108                 return this.name();
 109         }
 110
 111         /**
 112          * Checks if this is a SQC or not.
 113          *
 114          * @param __s The file name.
 115          * @return If this is a SQC ROM.
 116          * @throws NullPointerException On null arguments.
 117          * @since 2020/11/27
 118          */
 119         @Exported
 120         public static boolean isSqc(Path __s)
 121                 throws NullPointerException
 122         {
 123                 if (__s == null)
 124                         throw new NullPointerException("NARG");
 125
 126                 return SummerCoatJarLibrary.isSqc(__s.toString());
 127         }
 128
 129         /**
 130          * Checks if this is a SQC or not.
 131          *
 132          * @param __s The file name.
 133          * @return If this is a SQC ROM.
 134          * @throws NullPointerException On null arguments.
 135          * @since 2020/11/27
 136          */
 137         @Exported
 138         public static boolean isSqc(String __s)
 139                 throws NullPointerException
 140         {
 141                 if (__s == null)
 142                         throw new NullPointerException("NARG");
 143
 144                 return __s.endsWith(".sqc") || __s.endsWith(".SQC");
 145         }
 146 }