Skip to content

Commit

Permalink
Renamed to SimIO
Browse files Browse the repository at this point in the history
  • Loading branch information
Anthony Foxclaw committed Apr 15, 2020
1 parent be45222 commit 5dd4d6c
Show file tree
Hide file tree
Showing 53 changed files with 169 additions and 110 deletions.
18 changes: 6 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,19 @@
# SimPE.Interfaces
# SimIO

SimPE.Interfaces is a port of SimPE's Interface and Helper libraries to .NET Standard to allow for new or existing tools to make use of.

## API Compatibility

This port is **not** 100% API compatible with SimPE itself. The Helper library lacks Windows Forms and Registry, references required by the application, in order to remain OS-agnostic. It contains only the necessary classes needed for the interface library to function properly.

They'll likely be a name change in the not-so-distance future in order to avoid confusion and potential breakage with existing tools.
SimIO is a port of SimPE's I/O libraries to .NET Standard. It's not designed 100% API compatible with SimPE itself in order to remain OS-agnostic.

## Build Status

| Service | Status |
| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Github | [![Build](https://img.shields.io/github/workflow/status/tonytins/SimPE.Interfaces/build/master?logo=github)](https://github.com/tonytins/SimPE.Interfaces/actions) |
| Service | Status |
| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| Github | [![Build](https://img.shields.io/github/workflow/status/simtactics/SimIO/build/master?logo=github)](https://github.com/simtactics/SimIO/actions) |

## Authors

- **Anthony Foxclaw** - _Maintainer_ - [tonytins](https://github.com/tonytins)
- **Ambertation, Peter L Jones** - _Original work_

See also the list of [contributors](https://github.com/tonytins/SimPE.Interfaces/contributors) who participated in this project.
See also the list of [contributors](https://github.com/simtactics/SimIO/contributors) who participated in this project.

## License

Expand Down
4 changes: 2 additions & 2 deletions src/SimPE.Helper/Alias.cs → src/SimIO.Helper/Alias.cs
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@
using System.Collections;
using System.IO;
using System.Xml;
using SimPe.Interfaces;
using SimIO.Interfaces;

namespace SimPe.Data
namespace SimIO.Data
{
/// <summary>
/// Conects an value with a name
Expand Down
10 changes: 5 additions & 5 deletions src/SimPE.Helper/Helper.cs → src/SimIO.Helper/Helper.cs
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@
using System.Runtime.InteropServices;
using System.Text;
using System.Threading;
using SimPe.Data;
using SimIO.Data;

namespace SimPe
namespace SimIO
{
/// <summary>
/// Determins the Executable that was started
Expand Down Expand Up @@ -780,18 +780,18 @@ public static bool DebugMode
/// </summary>
/// <param name="flname"></param>
/// <returns></returns>
static readonly string _neighborhoodPackage = "_neighborhood.package";
static readonly string NeighborhoodPackage = "_neighborhood.package";
public static string GetMainNeighborhoodFile(string filename)
{
if (filename==null) return "";
var flname = Path.GetFileName(filename);
flname = flname.Trim().ToLower();

if (flname.EndsWith(_neighborhoodPackage)) return filename;
if (flname.EndsWith(NeighborhoodPackage)) return filename;
flname = Path.GetFileNameWithoutExtension(flname);
var parts = flname.Split(new[] {'_'}, 2);
if (parts.Length==0) return filename;
return Path.Combine(Path.GetDirectoryName(filename), parts[0] + _neighborhoodPackage);
return Path.Combine(Path.GetDirectoryName(filename), parts[0] + NeighborhoodPackage);
}

/// <summary>
Expand Down
2 changes: 1 addition & 1 deletion src/SimPE.Helper/IAlias.cs → src/SimIO.Helper/IAlias.cs
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
***************************************************************************/

namespace SimPe.Interfaces
namespace SimIO.Interfaces
{
/// <summary>
/// Interface for Value - Name Aliase
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
using System.Collections.Generic;
using System.Drawing;

namespace SimPe.Data
namespace SimIO.Data
{
public enum NeighborhoodSlots
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

using System;

namespace SimPe.Data
namespace SimIO.Data
{
/// <summary>
/// Overrides the Alias class
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
using System.Collections.Generic;
using System.Xml;

namespace SimPe.Data
namespace SimIO.Data
{

public class SemiGlobalListing : List<SemiGlobalAlias>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
<RootNamespace>SimPE.Helper</RootNamespace>
</PropertyGroup>

<ItemGroup>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
***************************************************************************/

namespace SimPe.Data
namespace SimIO.Data
{
/// <summary>
/// Conects an Type Id Value with a name
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

using System.Drawing;

namespace SimPe.Providers
namespace SimIO.Providers
{
public class CollectibleAlias
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
***************************************************************************/

using SimPe.Interfaces.Files;
using SimIO.Interfaces.Files;

namespace SimPe.Events
namespace SimIO.Events
{
/// <summary>
/// Used whenever the content
/// of a <see cref="SimPe.Interfaces.Files.IPackedFileDescriptor"/> changed
/// of a <see cref="IPackedFileDescriptor"/> changed
/// </summary>
public delegate void PackedFileChanged(IPackedFileDescriptor sender);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
***************************************************************************/

namespace SimPe.Interfaces
namespace SimIO.Interfaces
{
/// <summary>
/// Interface for Value - Name Aliase
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

using System.Collections.Generic;

namespace SimPe.Interfaces
namespace SimIO.Interfaces
{
/// <summary>
/// Implement this interface to get called with the SimPe command line
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
***************************************************************************/

namespace SimPe.Interfaces.Plugin
namespace SimIO.Interfaces.Plugin
{
/// <summary>
/// </summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@
***************************************************************************/

using System;
using SimPe.Interfaces.Files;
using SimIO.Interfaces.Files;

namespace SimPe.Interfaces.Providers
namespace SimIO.Interfaces.Providers
{
/// <summary>
/// Common Interface for Providers needing a Package File
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
***************************************************************************/

namespace SimPe.Interfaces.Wrapper
namespace SimIO.Interfaces.Wrapper
{
/// <summary>
/// Interface for Sim Description Files
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
***************************************************************************/

namespace SimPe.Interfaces.Wrapper
namespace SimIO.Interfaces.Wrapper
{
/// <summary>
/// Interface for Sim Description Files
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@
using System;
using System.Collections;
using System.Drawing;
using SimPe.Interfaces.Scenegraph;
using SimIO.Interfaces.Scenegraph;

namespace SimPe.Interfaces.Providers
namespace SimIO.Interfaces.Providers
{
public interface ILotItem
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@
***************************************************************************/

using System.Collections;
using SimPe.Interfaces.Scenegraph;
using SimIO.Interfaces.Scenegraph;

namespace SimPe.Interfaces.Providers
namespace SimIO.Interfaces.Providers
{
/// <summary>
/// Interface to obtain the SimFamilyNames Alias List from the Type Registry
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
using System;
using System.IO;

namespace SimPe.Interfaces.Files
namespace SimIO.Interfaces.Files
{
/// <summary>
/// Interface for PackeFile Classes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@
***************************************************************************/

using System;
using SimPe.Data;
using SimIO.Data;

namespace SimPe.Interfaces.Files
namespace SimIO.Interfaces.Files
{
/// <summary>
/// Structural Data of a .package Header
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
***************************************************************************/

namespace SimPe.Interfaces.Files
namespace SimIO.Interfaces.Files
{
/// <summary>
/// Hole Index of the File
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
***************************************************************************/

namespace SimPe.Interfaces.Files
namespace SimIO.Interfaces.Files
{
/// <summary>
/// Index Informations stored in the Header
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
using System;
using System.IO;

namespace SimPe.Interfaces.Files
namespace SimIO.Interfaces.Files
{
/// <summary>
/// Interface for a PackedFile object
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@
***************************************************************************/

using System;
using SimPe.Events;
using SimIO.Events;

namespace SimPe.Interfaces.Files
namespace SimIO.Interfaces.Files
{
/// <summary>
/// Interface for PackedFile Descriptors
Expand Down Expand Up @@ -52,7 +52,7 @@ public interface IPackedFileDescriptor : IPackedFileDescriptorBasic
/// </summary>
/// <remarks>
/// This is the public Change Listener. Developers can control in
/// <see cref="SetUserData"/>if this Event is fired. This Event will not fire if <see cref="SimPe.Interfaces.Plugin.Internal.SynchronizeUserData"/>
/// <see cref="SetUserData"/>if this Event is fired. This Event will not fire if <see cref="SimIO.Interfaces.Plugin.Internal.SynchronizeUserData"/>
/// is called (which changes the UserData).
/// </remarks>
event PackedFileChanged ChangedUserData;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
***************************************************************************/
using System;

namespace SimPe.Interfaces.Files
namespace SimIO.Interfaces.Files
{
/// <summary>
/// Interface for PackedFile Descriptors
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
***************************************************************************/

using SimPe.Data;
using SimIO.Data;

namespace SimPe.Interfaces.Files
namespace SimIO.Interfaces.Files
{
public interface IPackedFileDescriptorSimple
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
***************************************************************************/

using SimPe.Interfaces.Files;
using SimIO.Interfaces.Files;

namespace SimPe.Interfaces.Plugin.Internal
namespace SimIO.Interfaces.Plugin.Internal
{
/// <summary>
/// This Interface Implements Methods that must be provided by a PackedFile Wrapper
Expand Down Expand Up @@ -52,7 +52,7 @@ IPackedFileDescriptor FileDescriptor
/// Processe the Data stored in the sent File
/// </summary>
/// <param name="item">Contains a Scenegraph Item (which combines a FileDescriptor with a Package)</param>
void ProcessData(Interfaces.Scenegraph.IScenegraphFileIndexItem item);
void ProcessData(Scenegraph.IScenegraphFileIndexItem item);

/// <summary>
/// Processe the Data stored in the sent File
Expand All @@ -76,7 +76,7 @@ IPackedFileDescriptor FileDescriptor
/// </summary>
/// <param name="item">Contains a Scenegraph Item (which combines a FileDescriptor with a Package)</param>
/// <param name="catchex">true, if the Method should handle all occuring Exceptions</param>
void ProcessData(Interfaces.Scenegraph.IScenegraphFileIndexItem item, bool catchex);
void ProcessData(Scenegraph.IScenegraphFileIndexItem item, bool catchex);

/// <summary>
/// Processe the Data stored in the sent File
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
***************************************************************************/

namespace SimPe.Interfaces.Plugin.Internal
namespace SimIO.Interfaces.Plugin.Internal
{
/// <summary>
/// This Interface Implements Methods that must be provided by a PackedFile Wrapper
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
***************************************************************************/

using SimPe.Interfaces.Files;
using SimIO.Interfaces.Files;

namespace SimPe.Interfaces.Plugin.Internal
namespace SimIO.Interfaces.Plugin.Internal
{

/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
***************************************************************************/

using SimPe.Interfaces.Plugin.Internal;
using SimIO.Interfaces.Plugin.Internal;

namespace SimPe.Interfaces.Plugin
namespace SimIO.Interfaces.Plugin
{
/// <summary>
/// Interface for Filehanders that are able to save their content to a BinaryStream
Expand Down
Loading

0 comments on commit 5dd4d6c

Please sign in to comment.