SCJMapper-V2/SC/DProfileReader.cs
bm98 d1e77e3564 AC Alpha 2.0 Update
first push before testing - internal only
- lots of updates to comply with actual XML formats
- fixed actionmap versions with profile and mapping versions (removed ignoreversion)
- reworked blending
- add full mouse settings
2015-12-22 01:47:23 +01:00

366 lines
13 KiB
C#

using System;
using System.Collections.Generic;
using System.Text;
using System.Xml;
using System.IO;
namespace SCJMapper_V2
{
/// <summary>
/// should read the default profile - may be replacing the MappingVars once
/// Reads the profile as is and creates a CSV Map (internal legacy format) for clients
/// default bindings are read as AC1 style items i.e. not containing the device
/// </summary>
class DProfileReader
{
private static readonly log4net.ILog log = log4net.LogManager.GetLogger( System.Reflection.MethodBase.GetCurrentMethod( ).DeclaringType );
public Boolean ValidContent { get; set; }
private Stack<String> m_nodeNameStack = null; // element name stack - keeping track where we are
// state for the parser
enum EState
{
idle = 0,
inActionMap,
}
private EState m_state = EState.idle;
// an action map and its actions
class Action
{
public String name { get; set; } // the action name
public String devID { get; set; } // the input method K,J,X,P
private String m_defBinding = ""; // NOTE: this is AC1 style in the Profile - need to conver later when dumping out
public String defBinding { get { return m_defBinding; } set { m_defBinding = value; } } // DONT! need to clean this one, found spaces...
public String keyName
{ get { return devID + name; } } // prep for TreView usage - create a key from input+name
}
class ActionMap : List<Action> // carries the action list
{
public String name { get; set; } // the map name
};
Dictionary<String, ActionMap> m_aMap = null; // key would be the actionmap name
ActionMap m_currentMap = null;
// ****************** CLASS **********************
/// <summary>
/// cTor
/// </summary>
public DProfileReader( )
{
ValidContent = false; // default
}
/// <summary>
/// Returns the collected actionmaps as CSV (same format as MappingVars)
/// i.e. one line per actionmap where the first element is the actionmap and following are actions;defaultBinding lead by the input Key in uppercase (JKXP)
/// </summary>
public String CSVMap
{
get
{
log.Debug( "DProfileReader.CSVMap - Entry" );
String buf = "";
foreach ( ActionMap am in m_aMap.Values ) {
buf += am.name + ";";
foreach ( Action a in am ) {
buf += a.keyName + ";" + a.defBinding + ";"; // add default binding to the CSV
}
buf += String.Format( "\n" );
}
return buf;
}
}
/// <summary>
/// Assumes to be in an action element
/// retrieves the attributes and collects the various control=binding pairs
/// </summary>
/// <param name="xr">An XML reader @ StartElement</param>
private void CollectActions( XmlReader xr, Dictionary<string, string> attr )
{
// we collect actions for each input ie for K,J,X and P
if ( attr.ContainsKey( "joystick" ) ) {
Action ac = new Action( );
ac.name = attr["name"];
ac.devID = "J";
ac.defBinding = attr["joystick"];
if ( ac.defBinding == " " ) ac.defBinding = JoystickCls.BlendedInput;
if ( !String.IsNullOrEmpty( ac.defBinding ) ) {
if ( !ac.defBinding.StartsWith( "js1_" ) && !ac.defBinding.StartsWith( "jsx_" ) ) ac.defBinding = "js1_" + ac.defBinding; // fix AC 1.3
m_currentMap.Add( ac ); // finally add it to the current map if it was bound
}
}
if ( attr.ContainsKey( "keyboard" ) ) {
Action ac = new Action( );
ac.name = attr["name"];
ac.devID = "K";
ac.defBinding = attr["keyboard"];
if ( ac.defBinding == " " ) ac.defBinding = KeyboardCls.BlendedInput;
if ( !String.IsNullOrEmpty( ac.defBinding ) ) m_currentMap.Add( ac ); // finally add it to the current map if it was bound
}
if ( attr.ContainsKey( "mouse" ) ) { // 20151220BM: add mouse device (from AC 2.0 defaultProfile usage)
Action ac = new Action( );
ac.name = attr["name"];
ac.devID = "M";
ac.defBinding = attr["mouse"];
if ( ac.defBinding == " " ) ac.defBinding = MouseCls.BlendedInput;
if ( !String.IsNullOrEmpty( ac.defBinding ) ) m_currentMap.Add( ac ); // finally add it to the current map if it was bound
}
if ( attr.ContainsKey( "xboxpad" ) ) {
Action ac = new Action( );
ac.name = attr["name"];
ac.devID = "X";
ac.defBinding = attr["xboxpad"];
if ( ac.defBinding == " " ) ac.defBinding = GamepadCls.BlendedInput;
if ( !String.IsNullOrEmpty( ac.defBinding ) ) {
if ( !ac.defBinding.StartsWith( "xi_" ) ) ac.defBinding = "xi_" + ac.defBinding; // fix AC 1.3
m_currentMap.Add( ac ); // finally add it to the current map if it was bound
}
}
if ( attr.ContainsKey( "ps3pad" ) ) {
Action ac = new Action( );
ac.name = attr["name"];
ac.devID = "P";
ac.defBinding = attr["ps3pad"];
if ( ac.defBinding == " " ) ac.defBinding = GamepadCls.BlendedInput;
if ( !String.IsNullOrEmpty( ac.defBinding ) ) m_currentMap.Add( ac ); // finally add it to the current map if it was bound
}
}
/// <summary>
/// Read one 'empty' XML element
///
/// <name [attr="" ..] />
///
/// </summary>
/// <param name="xr">An XML reader @ StartElement</param>
/// <returns>True if reading can continue</returns>
private Boolean ReadEmptyElement( XmlReader xr )
{
Dictionary<String, String> attr = new Dictionary<string, string>( );
String eName = xr.Name;
switch ( xr.NodeType ) {
case XmlNodeType.Element:
//Console.Write( "<{0}", xr.Name );
while ( xr.MoveToNextAttribute( ) ) {
attr.Add( xr.Name, xr.Value ); // save the attributes
//Console.Write( " {0}='{1}'", xr.Name, xr.Value );
}
if ( m_state == EState.inActionMap ) {
// processing a valid action map - collect actions
if ( eName.ToLower( ) == "action" ) {
// this is an action.. - collect it
CollectActions( xr, attr );
}
}// if inmap
//Console.Write( ">\n" );
break;
case XmlNodeType.Text:
//Console.Write( xr.Value );
break;
case XmlNodeType.EndElement:
//Console.Write( "</{0}>\n", xr.Name );
break;
}
return true;
}
/// <summary>
/// Reads an action sub element
/// </summary>
/// <param name="xr">An XML reader @ StartElement</param>
private void ReadActionSub( XmlReader xr, String actionName )
{
//<action name="v_brake" onPress="1" onHold="1" onRelease="1" keyboard="space" xboxpad="xi_shoulderl+xi_shoulderr">
// <joystick input="js2_button7" />
// <joystick input="js2_button8" />
//</action>
//or
//<action name="v_hud_confirm" onPress="1" onRelease="1" xboxpad="xi_triggerL_btn+xi_a" joystick="js1_button19">
// <keyboard>
// <inputdata input="enter"/>
// </keyboard>
//</action>
Boolean done = false;
do {
xr.Read( ); // get next element
Dictionary<String, String> attr = new Dictionary<string, string>( );
String eName = xr.Name;
while ( xr.MoveToNextAttribute( ) ) {
attr.Add( xr.Name, xr.Value ); // save the attributes
//Console.Write( " {0}='{1}'", xr.Name, xr.Value );
}
xr.MoveToElement( ); // backup
Action ac = new Action( );
ac.name = actionName;
// the element name is a control
if ( xr.NodeType == XmlNodeType.EndElement ) {
done = ( xr.Name == "action" );
}
else if ( xr.IsEmptyElement ) {
// an attribute only element
ac.devID = ActionCls.DevID( eName );
ac.defBinding = attr["input"];
if ( !String.IsNullOrEmpty( ac.defBinding ) ) m_currentMap.Add( ac ); // finally add it to the current map if it was bound
}
else {
// one with subelements again
xr.Read( );
ac.devID = ActionCls.DevID( eName );
ac.defBinding = xr["input"];
if ( !String.IsNullOrEmpty( ac.defBinding ) ) m_currentMap.Add( ac ); // finally add it to the current map if it was bound
}
} while ( !done );
m_nodeNameStack.Pop( ); // action is finished
}
/// <summary>
/// Read one XML element
///
/// <name attr="">
/// [ Xelement ]
/// </name>
///
/// </summary>
/// <param name="xr">An XML reader @ StartElement</param>
/// <returns>True if reading can continue</returns>
private Boolean ReadElement( XmlReader xr )
{
Dictionary<String, String> attr = new Dictionary<string, string>( );
String eName = xr.Name;
switch ( xr.NodeType ) {
case XmlNodeType.Element:
//Console.Write( "<{0}", xr.Name );
while ( xr.MoveToNextAttribute( ) ) {
attr.Add( xr.Name, xr.Value ); // save the attributes
//Console.Write( " {0}='{1}'", xr.Name, xr.Value );
}
// now here we could have an actionmap start
if ( m_state == EState.idle ) {
if ( m_nodeNameStack.Peek( ).ToLower( ) == "actionmap" ) {
// check for a valid one
String mapName = attr["name"];
String item = Array.Find( ActionMapsCls.ActionMaps, delegate( String sstr ) {
return sstr == mapName;
} );
if ( !String.IsNullOrEmpty( item ) ) {
// finally.... it is a valid actionmap
m_currentMap = new ActionMap( );
m_currentMap.name = mapName;
m_aMap.Add( mapName, m_currentMap ); // add to our inventory
m_state = EState.inActionMap; // now we are in and processing the map
}
}
}
else if ( m_state == EState.inActionMap ) {
// processing a valid action map - collect actions
if ( eName.ToLower( ) == "action" ) {
// this is an action.. - collect it
CollectActions( xr, attr );
ReadActionSub( xr, attr["name"] ); // a non empty action element may have a sub element
}
}
//Console.Write( ">\n" );
break;
case XmlNodeType.Text:
//Console.Write( xr.Value );
break;
case XmlNodeType.EndElement:
//Console.Write( "</{0}>\n", xr.Name );
break;
}
return true;
}
/// <summary>
/// Read the xml part
/// </summary>
/// <param name="xr"></param>
/// <returns></returns>
private Boolean ReadXML( XmlReader xr )
{
log.Debug( "DProfileReader.ReadXML - Entry" );
Boolean retVal = true;
if ( ActionMapsCls.ActionMaps.Length == 0 ) ActionMapsCls.LoadSupportedActionMaps( ); // make sure we have them loaded ( refactoring to get a singleton or so...)
try {
do {
if ( xr.IsStartElement( ) ) {
m_nodeNameStack.Push( xr.Name );
if ( xr.IsEmptyElement ) {
retVal = retVal && ReadEmptyElement( xr );
m_nodeNameStack.Pop( ); // empty ones end inline
}
else {
retVal = retVal && ReadElement( xr );
}
}
else if ( xr.NodeType == XmlNodeType.EndElement ) {
//Console.Write( "</{0}>\n", xr.Name );
String exitElement = m_nodeNameStack.Pop( );
if ( m_state == EState.inActionMap )
if ( exitElement.ToLower( ) == "actionmap" ) m_state = EState.idle; // finished
}
} while ( xr.Read( ) );
if ( m_nodeNameStack.Count == 0 )
return retVal && true;
else
return false;
}
catch ( Exception ex ) {
// get any exceptions from reading
log.Error( "DProfileReader.ReadXML - unexpected", ex );
return false;
}
}
/// <summary>
/// Read the defaultProfile.xml - do some sanity check
/// </summary>
/// <param name="xml">the XML action defaultProfile Content</param>
/// <returns>True if an action was decoded</returns>
public Boolean fromXML( String xml )
{
log.Debug( "DProfileReader.fromXML - Entry" );
XmlReaderSettings settings = new XmlReaderSettings( );
settings.ConformanceLevel = ConformanceLevel.Fragment;
settings.IgnoreWhitespace = true;
settings.IgnoreComments = true;
XmlReader reader = XmlReader.Create( new StringReader( xml ), settings );
m_nodeNameStack = new Stack<String>( );
m_aMap = new Dictionary<String, ActionMap>( );
reader.Read( );
ValidContent = ReadXML( reader );
return ValidContent;
}
}
}