ise_interface.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- 
 /*******************************************************************************
 * Copyright (c) 2014 Elphel, Inc.
 * This file is a part of VDT plug-in.
 * VDT plug-in is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * VDT plug-in is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * 
 *  Additional permission under GNU GPL version 3 section 7:
 * If you modify this Program, or any covered work, by linking or combining it
 * with Eclipse or Eclipse plugins (or a modified version of those libraries),
 * containing parts covered by the terms of EPL/CPL, the licensors of this
 * Program grant you additional permission to convey the resulting work.
 * {Corresponding Source for a non-source form of such a combination shall
 * include the source code for the parts of Eclipse or Eclipse plugins used
 * as well as that of the covered work.}
 *******************************************************************************/
 -->
<vdt-project>
	<interface name="ISEInterface" extends="FPGAPprojectInterface">
		<syntax name="GrepFilterProblemSyntax"        format='| grep --line-buffered -v  "%%ParamName"' />
		<syntax name="GrepFilterProblemOtherSyntax"   format='%(| grep --line-buffered -v  "%%ParamValue"%|\n%)' />
		<typedef name="intstyleType">
      		<paramtype kind= "enum" base="String">
      			<item value="ise"    label="Indicates the program is being run as part of an integrated design environment"/>
      			<item value="xflow"  label="Indicates the program is being run as part of an integrated batch flow"/>
      			<item value="silent" label="Only errors and warnings are output"/>
      		</paramtype>
    	</typedef>
    	<typedef name = "Cardinal_M1_100">
            <paramtype kind="number" lo="-1" hi="100" format="%d" />
        </typedef>
	    <typedef name="ParserModeType">
      		<paramtype kind= "enum" base="String">
      			<item value="0"   label="Tool output is parsed immediately"/>
      			<item value="1"   label="Tool output is delayed by not more than 1 line when consolidating bits"/>
      			<item value="2"   label="As '1', but do not show same bits again"/>
      			<item value="3"   label="All tool output containg hierarchical output is delayed to the very end"/>
      		</paramtype>
    	</typedef>
    	
	 <syntax name="DashNamePart"    format="-%%ParamName %part" />

	<syntax name="DashListQuoted"      format='-%%ParamName "%(%%ParamValue%| %)"' />
	<syntax name="DashListBraced"      format="-%%ParamName {%(%%ParamValue%| %)}" />
 

		
	
<!-- <syntax name="QuietSyntax"     format=" -quiet" />
		<syntax name="VerboseSyntax"   format=" -verbose" />
		<syntax name="DirectiveSyntax" format=" -directive %%ParamValue" /> -->
		
	
	<!-- 
		<syntax name="ProgramSyntax" format="%(%%ParamValue%|\n%)" />
		<syntax name="read_xdc_syntax" format="%(read_xdc %%ParamValue%|\n%)" /> -->
		
	</interface>
	<!--  Abstract tools to be inherited by instances used for various ISE tools -->	
	<!--  Restore tool for ISE -->
	<tool name="RestoreISE" label="Restore state after ISE tool"
	    project="FPGA_project"
		interface="ISEInterface"
		package="FPGA_package"
		shell="/bin/bash"
		abstract="true">
		<output>
			<line name="ise_pre_restore">
				"-c"
				<!-- Create workspace directory on remote server if it did not exist -->
				"ssh"
				"-oBatchMode=yes"
				"-l %RemoteUser %RemoteHost"
				"'"
				"mkdir -p"
				"%ISEWorkspace"
				"' ;"
				<!-- Copy snapshot generated earlier from local to remote -->
<!-- 			"rsync -avrR -e ssh"  -->
				"rsync -avr -e ssh"
				<!--  from: -->
				"%ISELocalDir/%%StateFile"
				<!-- to: -->
				"%RemoteUser@%RemoteHost:%ISEWorkspace/"
				";"
			</line>
			
			<line name="ise_restore"
			      dest="ISEConsole"
			      mark="``" 
			      sep=" "
			      failure="ERROR:"
			      prompt="@@FINISH@@"
			      log="">
			      "cd ~/%ISEWorkspace\n"
				<!-- optionally remove project directory on remote before unpacking snapshot -->
			      <if ISECleanRestore="true">
			        "rm -f -r"
			        "%ISEProjectRoot;"
			      </if>
				<!-- Unpack snapshot on remote -->
			      "tar -xzf"
			      "%%StateFile\n"
				<!-- Delete snapshot archive on remote -->
			      "rm -f"
			      "%%StateFile\n"
		          "echo \"@@FINISH@@\"\n"
		    </line>
		</output>
	</tool>

	<!--  Save tool for ISE tool -->
	<tool name="SaveISE"
	    label="SaveISE"
	    project="FPGA_project"
		interface="ISEInterface"
		package="FPGA_package"
		shell="/bin/bash"
		abstract="true">
		<output>
			<line name="ise_save"
			      dest="ISEConsole"
			      mark="``" 
			      sep=" "
			      prompt="@@FINISH@@"
			      failure="ERROR:"
			      log="">
			      "cd ~/%ISEWorkspace\n"
			<!-- Remove old snapshot if it exists (unlikely as it includes timestamp?) -->
			      "rm -f"
			      "%%StateFile"
			      "\n"
			<!-- Create snapshot at remote (workspace, below project) -->
			      "tar -czf"
			      "%%StateFile"
			      "%%ProjectName"
			      "\n"
	      		  "echo \"@@FINISH@@\"\n"
			</line>
			<line name="ise_copy_after_save">
					"-c"
					<!-- Copy snapshot from remote to local -->
					"mkdir -p %ISELocalDir ;"
					"rsync -avr -e ssh"
					"%RemoteUser@%RemoteHost:%ISEWorkspace/%%StateFile"
					"%%StateDir/ ;"
					<!-- Remove snapshot at remote -->
					"ssh"
					"-oBatchMode=yes"
					"-l %RemoteUser %RemoteHost"
					"'"
					"rm -f"
					"%ISEWorkspace/%%StateFile"
					"' ;"
			</line>
		</output>		
	</tool>
</vdt-project>