Crossfire JXClient, Trunk
DefaultScriptProcess.java
Go to the documentation of this file.
1 /*
2  * This file is part of JXClient, the Fullscreen Java Crossfire Client.
3  *
4  * JXClient is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * JXClient is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with JXClient; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
17  *
18  * Copyright (C) 2005-2008 Yann Chachkoff
19  * Copyright (C) 2006-2017,2019-2023 Andreas Kirschbaum
20  * Copyright (C) 2010-2012,2014-2018,2020-2023 Nicolas Weeger
21  */
22 
23 package com.realtime.crossfire.jxclient.scripts;
24 
33 import java.io.BufferedReader;
34 import java.io.IOException;
35 import java.io.InputStreamReader;
36 import java.io.OutputStreamWriter;
37 import java.nio.charset.Charset;
38 import org.jetbrains.annotations.NotNull;
39 import org.jetbrains.annotations.Nullable;
40 
46 
50  @NotNull
51  private final Process process;
52 
56  @NotNull
57  private final BufferedReader in;
58 
62  @NotNull
63  private final OutputStreamWriter osw;
64 
68  private boolean killed;
69 
84  public DefaultScriptProcess(final int scriptId, @NotNull final String filename, @NotNull final CommandQueue commandQueue, @NotNull final CrossfireServerConnection crossfireServerConnection, @NotNull final Stats stats, @NotNull final FloorView floorView, @NotNull final ItemSet itemSet, @NotNull final SpellsManager spellsManager, @NotNull final MapUpdaterState mapUpdaterState, @NotNull final SkillSet skillSet) throws IOException {
86  process = Runtime.getRuntime().exec(filename);
87  in = new BufferedReader(new InputStreamReader(process.getInputStream(), Charset.defaultCharset()));
88  osw = new OutputStreamWriter(process.getOutputStream(), Charset.defaultCharset());
89  }
90 
91  @Nullable
92  @Override
93  protected String readFromScript() throws IOException {
94  return in.readLine();
95  }
96 
97  @Nullable
98  @Override
99  protected String waitForTermination() {
100  try {
101  final int exitStatus = process.waitFor();
102  return exitStatus == 0 ? null : "exit "+exitStatus;
103  } catch (final InterruptedException ex) {
104  return ex.getMessage();
105  }
106  }
107 
108  @Override
109  protected void writeToScript(@NotNull final String data) throws IOException {
110  if (killed) {
111  return;
112  }
113 
114  osw.write(data);
115  osw.flush();
116  }
117 
118  @Override
119  public void killScript() {
120  killed = true;
121  process.destroy();
122  }
123 
124 }
com.realtime.crossfire.jxclient
com.realtime.crossfire.jxclient.scripts.AbstractScriptProcess.filename
final String filename
The script command including arguments.
Definition: AbstractScriptProcess.java:73
com.realtime.crossfire.jxclient.scripts.AbstractScriptProcess.commandQueue
final CommandQueue commandQueue
The CommandQueue for sending commands.
Definition: AbstractScriptProcess.java:79
com.realtime.crossfire.jxclient.server
com.realtime.crossfire.jxclient.items.ItemSet
Model class maintaining the CfItems known to the player.
Definition: ItemSet.java:44
com.realtime.crossfire.jxclient.map
Implements the map model which is shown in the map and magic map views.
Definition: CfMap.java:23
com.realtime.crossfire.jxclient.server.crossfire.CrossfireServerConnection
Adds encoding/decoding of crossfire protocol packets to a ServerConnection.
Definition: CrossfireServerConnection.java:37
com.realtime.crossfire.jxclient.scripts.DefaultScriptProcess.writeToScript
void writeToScript(@NotNull final String data)
Sends some data to the script process.
Definition: DefaultScriptProcess.java:109
com.realtime.crossfire.jxclient.scripts.DefaultScriptProcess.process
final Process process
The Process instance for the executed child process.
Definition: DefaultScriptProcess.java:51
com.realtime.crossfire.jxclient.scripts.AbstractScriptProcess.mapUpdaterState
final MapUpdaterState mapUpdaterState
The MapUpdaterState instance to use.
Definition: AbstractScriptProcess.java:115
com.realtime.crossfire.jxclient.spells.SpellsManager
Manages all known spells.
Definition: SpellsManager.java:50
com.realtime.crossfire.jxclient.scripts.DefaultScriptProcess.killScript
void killScript()
Kills the script process.
Definition: DefaultScriptProcess.java:119
com.realtime.crossfire.jxclient.scripts.AbstractScriptProcess.itemSet
final ItemSet itemSet
The ItemSet instance to use.
Definition: AbstractScriptProcess.java:103
com.realtime.crossfire.jxclient.skills
Definition: Skill.java:23
com.realtime.crossfire.jxclient.scripts.AbstractScriptProcess.scriptId
final int scriptId
The script ID identifying this script instance.
Definition: AbstractScriptProcess.java:67
com.realtime.crossfire.jxclient.scripts.AbstractScriptProcess.crossfireServerConnection
final CrossfireServerConnection crossfireServerConnection
The connection instance.
Definition: AbstractScriptProcess.java:85
com.realtime.crossfire.jxclient.scripts.DefaultScriptProcess.DefaultScriptProcess
DefaultScriptProcess(final int scriptId, @NotNull final String filename, @NotNull final CommandQueue commandQueue, @NotNull final CrossfireServerConnection crossfireServerConnection, @NotNull final Stats stats, @NotNull final FloorView floorView, @NotNull final ItemSet itemSet, @NotNull final SpellsManager spellsManager, @NotNull final MapUpdaterState mapUpdaterState, @NotNull final SkillSet skillSet)
Creates a new instance.
Definition: DefaultScriptProcess.java:84
com.realtime.crossfire.jxclient.scripts.DefaultScriptProcess.readFromScript
String readFromScript()
Reads a line from the script process.
Definition: DefaultScriptProcess.java:93
com.realtime.crossfire.jxclient.stats.Stats
This is the representation of all the statistics of a player, like its speed or its experience.
Definition: Stats.java:44
com.realtime.crossfire.jxclient.scripts.DefaultScriptProcess
A script process that executes an external command.
Definition: DefaultScriptProcess.java:45
com.realtime.crossfire.jxclient.server.crossfire
Definition: AbstractCrossfireServerConnection.java:23
com.realtime.crossfire.jxclient.scripts.DefaultScriptProcess.waitForTermination
String waitForTermination()
Waits until the script has terminated.
Definition: DefaultScriptProcess.java:99
com.realtime.crossfire.jxclient.scripts.AbstractScriptProcess.stats
final Stats stats
The Stats instance to watch.
Definition: AbstractScriptProcess.java:91
com.realtime.crossfire.jxclient.scripts.DefaultScriptProcess.in
final BufferedReader in
The BufferedReader of process.
Definition: DefaultScriptProcess.java:57
com.realtime.crossfire.jxclient.queue
Definition: CommandQueue.java:23
com.realtime.crossfire
com.realtime.crossfire.jxclient.scripts.DefaultScriptProcess.killed
boolean killed
Whether this script has been killed.
Definition: DefaultScriptProcess.java:68
com.realtime
com
com.realtime.crossfire.jxclient.scripts.AbstractScriptProcess.floorView
final FloorView floorView
The FloorView to use.
Definition: AbstractScriptProcess.java:97
com.realtime.crossfire.jxclient.items
Definition: AbstractItemView.java:23
com.realtime.crossfire.jxclient.scripts.AbstractScriptProcess
Default implementation for ScriptProcesses.
Definition: AbstractScriptProcess.java:55
com.realtime.crossfire.jxclient.scripts.AbstractScriptProcess.spellsManager
final SpellsManager spellsManager
The SpellsManager instance to use.
Definition: AbstractScriptProcess.java:109
com.realtime.crossfire.jxclient.items.FloorView
Provides a view to all items comprising the current floor view.
Definition: FloorView.java:36
com.realtime.crossfire.jxclient.skills.SkillSet
Maintain the set of skills as sent by the server.
Definition: SkillSet.java:39
com.realtime.crossfire.jxclient.map.MapUpdaterState
Update a CfMap model from protocol commands.
Definition: MapUpdaterState.java:49
com.realtime.crossfire.jxclient.scripts.AbstractScriptProcess.skillSet
final SkillSet skillSet
The SkillSet for looking up skill names.
Definition: AbstractScriptProcess.java:121
com.realtime.crossfire.jxclient.queue.CommandQueue
Maintains the pending (ncom) commands sent to the server.
Definition: CommandQueue.java:38
com.realtime.crossfire.jxclient.scripts.DefaultScriptProcess.osw
final OutputStreamWriter osw
The OutputStreamWriter associated with process.
Definition: DefaultScriptProcess.java:63
com.realtime.crossfire.jxclient.stats
Definition: ActiveSkillWatcher.java:23
com.realtime.crossfire.jxclient.spells
Definition: Spell.java:23