4
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
5
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
9
<meta name="viewport" content="width=device-width, initial-scale=1.0">
11
<title>terminatorlib.ipc — terminatorlib 0.98 documentation</title>
27
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
33
<link rel="top" title="terminatorlib 0.98 documentation" href="../../index.html"/>
34
<link rel="up" title="Module code" href="../index.html"/>
37
<script src="_static/js/modernizr.min.js"></script>
41
<body class="wy-body-for-nav" role="document">
43
<div class="wy-grid-for-nav">
46
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
47
<div class="wy-side-nav-search">
51
<a href="../../index.html" class="icon icon-home"> terminatorlib
59
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
60
<input type="text" name="q" placeholder="Search docs" />
61
<input type="hidden" name="check_keywords" value="yes" />
62
<input type="hidden" name="area" value="default" />
69
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
74
<li class="toctree-l1"><a class="reference internal" href="../../terminatorlib.html">terminatorlib package</a><ul>
75
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#subpackages">Subpackages</a><ul>
76
<li class="toctree-l3"><a class="reference internal" href="../../terminatorlib.configobj.html">terminatorlib.configobj package</a><ul>
77
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.configobj.html#submodules">Submodules</a></li>
78
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.configobj.html#module-terminatorlib.configobj.configobj">terminatorlib.configobj.configobj module</a></li>
79
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.configobj.html#module-terminatorlib.configobj.validate">terminatorlib.configobj.validate module</a></li>
80
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.configobj.html#module-terminatorlib.configobj">Module contents</a></li>
83
<li class="toctree-l3"><a class="reference internal" href="../../terminatorlib.plugins.html">terminatorlib.plugins package</a><ul>
84
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#submodules">Submodules</a></li>
85
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins.activitywatch">terminatorlib.plugins.activitywatch module</a></li>
86
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins.custom_commands">terminatorlib.plugins.custom_commands module</a></li>
87
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins.logger">terminatorlib.plugins.logger module</a></li>
88
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins.maven">terminatorlib.plugins.maven module</a></li>
89
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins.terminalshot">terminatorlib.plugins.terminalshot module</a></li>
90
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins.testplugin">terminatorlib.plugins.testplugin module</a></li>
91
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins.url_handlers">terminatorlib.plugins.url_handlers module</a></li>
92
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins">Module contents</a></li>
97
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#submodules">Submodules</a></li>
98
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.borg">terminatorlib.borg module</a></li>
99
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.config">terminatorlib.config module</a></li>
100
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.container">terminatorlib.container module</a></li>
101
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.cwd">terminatorlib.cwd module</a></li>
102
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.debugserver">terminatorlib.debugserver module</a></li>
103
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.editablelabel">terminatorlib.editablelabel module</a></li>
104
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.encoding">terminatorlib.encoding module</a></li>
105
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.factory">terminatorlib.factory module</a></li>
106
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.freebsd">terminatorlib.freebsd module</a></li>
107
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.ipc">terminatorlib.ipc module</a></li>
108
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.keybindings">terminatorlib.keybindings module</a></li>
109
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.layoutlauncher">terminatorlib.layoutlauncher module</a></li>
110
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.notebook">terminatorlib.notebook module</a></li>
111
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.optionparse">terminatorlib.optionparse module</a></li>
112
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.paned">terminatorlib.paned module</a></li>
113
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.plugin">terminatorlib.plugin module</a></li>
114
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.prefseditor">terminatorlib.prefseditor module</a></li>
115
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.searchbar">terminatorlib.searchbar module</a></li>
116
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.signalman">terminatorlib.signalman module</a></li>
117
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.terminal">terminatorlib.terminal module</a></li>
118
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.terminal_popup_menu">terminatorlib.terminal_popup_menu module</a></li>
119
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.terminator">terminatorlib.terminator module</a></li>
120
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.titlebar">terminatorlib.titlebar module</a></li>
121
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.translation">terminatorlib.translation module</a></li>
122
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.util">terminatorlib.util module</a></li>
123
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.version">terminatorlib.version module</a></li>
124
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.window">terminatorlib.window module</a></li>
125
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib">Module contents</a></li>
136
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
139
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
140
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
141
<a href="../../index.html">terminatorlib</a>
146
<div class="wy-nav-content">
147
<div class="rst-content">
148
<div role="navigation" aria-label="breadcrumbs navigation">
149
<ul class="wy-breadcrumbs">
150
<li><a href="../../index.html">Docs</a> »</li>
152
<li><a href="../index.html">Module code</a> »</li>
154
<li>terminatorlib.ipc</li>
155
<li class="wy-breadcrumbs-aside">
163
<div role="main" class="document">
165
<h1>Source code for terminatorlib.ipc</h1><div class="highlight"><pre>
166
<span class="c">#!/usr/bin/python</span>
167
<span class="c"># Terminator by Chris Jones <cmsj@tenshu.net></span>
168
<span class="c"># GPL v2 only</span>
169
<span class="sd">"""ipc.py - DBus server and API calls"""</span>
171
<span class="kn">import</span> <span class="nn">gtk</span>
172
<span class="kn">import</span> <span class="nn">dbus.service</span>
173
<span class="kn">from</span> <span class="nn">dbus.exceptions</span> <span class="kn">import</span> <span class="n">DBusException</span>
174
<span class="kn">import</span> <span class="nn">dbus.glib</span>
175
<span class="kn">from</span> <span class="nn">borg</span> <span class="kn">import</span> <span class="n">Borg</span>
176
<span class="kn">from</span> <span class="nn">terminator</span> <span class="kn">import</span> <span class="n">Terminator</span>
177
<span class="kn">from</span> <span class="nn">config</span> <span class="kn">import</span> <span class="n">Config</span>
178
<span class="kn">from</span> <span class="nn">factory</span> <span class="kn">import</span> <span class="n">Factory</span>
179
<span class="kn">from</span> <span class="nn">util</span> <span class="kn">import</span> <span class="n">dbg</span>
181
<span class="n">CONFIG</span> <span class="o">=</span> <span class="n">Config</span><span class="p">()</span>
182
<span class="k">if</span> <span class="ow">not</span> <span class="n">CONFIG</span><span class="p">[</span><span class="s">'dbus'</span><span class="p">]:</span>
183
<span class="c"># The config says we are not to load dbus, so pretend like we can't</span>
184
<span class="n">dbg</span><span class="p">(</span><span class="s">'dbus disabled'</span><span class="p">)</span>
185
<span class="k">raise</span> <span class="ne">ImportError</span>
187
<span class="n">BUS_BASE</span> <span class="o">=</span> <span class="s">'net.tenshu.Terminator'</span>
188
<span class="n">BUS_PATH</span> <span class="o">=</span> <span class="s">'/net/tenshu/Terminator'</span>
189
<span class="k">try</span><span class="p">:</span>
190
<span class="c"># Try and include the X11 display name in the dbus bus name</span>
191
<span class="n">DISPLAY</span> <span class="o">=</span> <span class="nb">hex</span><span class="p">(</span><span class="nb">hash</span><span class="p">(</span><span class="n">gtk</span><span class="o">.</span><span class="n">gdk</span><span class="o">.</span><span class="n">get_display</span><span class="p">()))</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s">'-'</span><span class="p">,</span> <span class="s">'_'</span><span class="p">)</span>
192
<span class="n">BUS_NAME</span> <span class="o">=</span> <span class="s">'</span><span class="si">%s%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">BUS_BASE</span><span class="p">,</span> <span class="n">DISPLAY</span><span class="p">)</span>
193
<span class="k">except</span><span class="p">:</span>
194
<span class="n">BUS_NAME</span> <span class="o">=</span> <span class="n">BUS_BASE</span>
196
<div class="viewcode-block" id="DBusService"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.ipc.DBusService">[docs]</a><span class="k">class</span> <span class="nc">DBusService</span><span class="p">(</span><span class="n">Borg</span><span class="p">,</span> <span class="n">dbus</span><span class="o">.</span><span class="n">service</span><span class="o">.</span><span class="n">Object</span><span class="p">):</span>
197
<span class="sd">"""DBus Server class. This is implemented as a Borg"""</span>
198
<span class="n">bus_name</span> <span class="o">=</span> <span class="bp">None</span>
199
<span class="n">bus_path</span> <span class="o">=</span> <span class="bp">None</span>
200
<span class="n">terminator</span> <span class="o">=</span> <span class="bp">None</span>
202
<div class="viewcode-block" id="DBusService.__init__"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.ipc.DBusService.__init__">[docs]</a> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
203
<span class="sd">"""Class initialiser"""</span>
204
<span class="n">Borg</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span><span class="p">)</span>
205
<span class="bp">self</span><span class="o">.</span><span class="n">prepare_attributes</span><span class="p">()</span>
206
<span class="n">dbus</span><span class="o">.</span><span class="n">service</span><span class="o">.</span><span class="n">Object</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">bus_name</span><span class="p">,</span> <span class="n">BUS_PATH</span><span class="p">)</span>
208
<div class="viewcode-block" id="DBusService.prepare_attributes"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.ipc.DBusService.prepare_attributes">[docs]</a> <span class="k">def</span> <span class="nf">prepare_attributes</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
209
<span class="sd">"""Ensure we are populated"""</span>
210
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">bus_name</span><span class="p">:</span>
211
<span class="n">dbg</span><span class="p">(</span><span class="s">'Checking for bus name availability: </span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="n">BUS_NAME</span><span class="p">)</span>
212
<span class="n">bus</span> <span class="o">=</span> <span class="n">dbus</span><span class="o">.</span><span class="n">SessionBus</span><span class="p">()</span>
213
<span class="n">proxy</span> <span class="o">=</span> <span class="n">bus</span><span class="o">.</span><span class="n">get_object</span><span class="p">(</span><span class="s">'org.freedesktop.DBus'</span><span class="p">,</span>
214
<span class="s">'/org/freedesktop/DBus'</span><span class="p">)</span>
215
<span class="n">flags</span> <span class="o">=</span> <span class="mi">1</span> <span class="o">|</span> <span class="mi">4</span> <span class="c"># allow replacement | do not queue</span>
216
<span class="k">if</span> <span class="ow">not</span> <span class="n">proxy</span><span class="o">.</span><span class="n">RequestName</span><span class="p">(</span><span class="n">BUS_NAME</span><span class="p">,</span> <span class="n">dbus</span><span class="o">.</span><span class="n">UInt32</span><span class="p">(</span><span class="n">flags</span><span class="p">))</span> <span class="ow">in</span> <span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">4</span><span class="p">):</span>
217
<span class="n">dbg</span><span class="p">(</span><span class="s">'bus name unavailable: </span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="n">BUS_NAME</span><span class="p">)</span>
218
<span class="k">raise</span> <span class="n">dbus</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</span><span class="n">DBusException</span><span class="p">(</span>
219
<span class="s">"Couldn't get DBus name </span><span class="si">%s</span><span class="s">: Name exists"</span> <span class="o">%</span> <span class="n">BUS_NAME</span><span class="p">)</span>
220
<span class="bp">self</span><span class="o">.</span><span class="n">bus_name</span> <span class="o">=</span> <span class="n">dbus</span><span class="o">.</span><span class="n">service</span><span class="o">.</span><span class="n">BusName</span><span class="p">(</span><span class="n">BUS_NAME</span><span class="p">,</span>
221
<span class="n">bus</span><span class="o">=</span><span class="n">dbus</span><span class="o">.</span><span class="n">SessionBus</span><span class="p">())</span>
222
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">bus_path</span><span class="p">:</span>
223
<span class="bp">self</span><span class="o">.</span><span class="n">bus_path</span> <span class="o">=</span> <span class="n">BUS_PATH</span>
224
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">terminator</span><span class="p">:</span>
225
<span class="bp">self</span><span class="o">.</span><span class="n">terminator</span> <span class="o">=</span> <span class="n">Terminator</span><span class="p">()</span>
227
<span class="nd">@dbus.service.method</span><span class="p">(</span><span class="n">BUS_NAME</span><span class="p">,</span> <span class="n">in_signature</span><span class="o">=</span><span class="s">'a{ss}'</span><span class="p">)</span>
228
<div class="viewcode-block" id="DBusService.new_window"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.ipc.DBusService.new_window">[docs]</a> <span class="k">def</span> <span class="nf">new_window</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">options</span><span class="o">=</span><span class="n">dbus</span><span class="o">.</span><span class="n">Dictionary</span><span class="p">()):</span>
229
<span class="sd">"""Create a new Window"""</span>
230
<span class="n">dbg</span><span class="p">(</span><span class="s">'dbus method called: new_window with parameters </span><span class="si">%s</span><span class="s">'</span><span class="o">%</span><span class="p">(</span><span class="n">options</span><span class="p">))</span>
231
<span class="n">oldopts</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">terminator</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">options_get</span><span class="p">()</span>
232
<span class="n">oldopts</span><span class="o">.</span><span class="n">__dict__</span> <span class="o">=</span> <span class="n">options</span>
233
<span class="bp">self</span><span class="o">.</span><span class="n">terminator</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">options_set</span><span class="p">(</span><span class="n">oldopts</span><span class="p">)</span>
234
<span class="bp">self</span><span class="o">.</span><span class="n">terminator</span><span class="o">.</span><span class="n">create_layout</span><span class="p">(</span><span class="n">oldopts</span><span class="o">.</span><span class="n">layout</span><span class="p">)</span>
235
<span class="bp">self</span><span class="o">.</span><span class="n">terminator</span><span class="o">.</span><span class="n">layout_done</span><span class="p">()</span>
237
<span class="nd">@dbus.service.method</span><span class="p">(</span><span class="n">BUS_NAME</span><span class="p">,</span> <span class="n">in_signature</span><span class="o">=</span><span class="s">'a{ss}'</span><span class="p">)</span>
238
<div class="viewcode-block" id="DBusService.new_tab"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.ipc.DBusService.new_tab">[docs]</a> <span class="k">def</span> <span class="nf">new_tab</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">options</span><span class="o">=</span><span class="n">dbus</span><span class="o">.</span><span class="n">Dictionary</span><span class="p">()):</span>
239
<span class="sd">"""Create a new tab"""</span>
240
<span class="n">dbg</span><span class="p">(</span><span class="s">'dbus method called: new_tab with parameters </span><span class="si">%s</span><span class="s">'</span><span class="o">%</span><span class="p">(</span><span class="n">options</span><span class="p">))</span>
241
<span class="n">oldopts</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">terminator</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">options_get</span><span class="p">()</span>
242
<span class="n">oldopts</span><span class="o">.</span><span class="n">__dict__</span> <span class="o">=</span> <span class="n">options</span>
243
<span class="bp">self</span><span class="o">.</span><span class="n">terminator</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">options_set</span><span class="p">(</span><span class="n">oldopts</span><span class="p">)</span>
244
<span class="n">window</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">terminator</span><span class="o">.</span><span class="n">get_windows</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span>
245
<span class="n">window</span><span class="o">.</span><span class="n">tab_new</span><span class="p">()</span>
247
<span class="nd">@dbus.service.method</span><span class="p">(</span><span class="n">BUS_NAME</span><span class="p">)</span>
248
<div class="viewcode-block" id="DBusService.terminal_hsplit"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.ipc.DBusService.terminal_hsplit">[docs]</a> <span class="k">def</span> <span class="nf">terminal_hsplit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">uuid</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
249
<span class="sd">"""Split a terminal horizontally, by UUID"""</span>
250
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">terminal_split</span><span class="p">(</span><span class="n">uuid</span><span class="p">,</span> <span class="bp">True</span><span class="p">)</span>
252
<span class="nd">@dbus.service.method</span><span class="p">(</span><span class="n">BUS_NAME</span><span class="p">)</span>
253
<div class="viewcode-block" id="DBusService.terminal_vsplit"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.ipc.DBusService.terminal_vsplit">[docs]</a> <span class="k">def</span> <span class="nf">terminal_vsplit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">uuid</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
254
<span class="sd">"""Split a terminal vertically, by UUID"""</span>
255
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">terminal_split</span><span class="p">(</span><span class="n">uuid</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span>
257
<div class="viewcode-block" id="DBusService.terminal_split"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.ipc.DBusService.terminal_split">[docs]</a> <span class="k">def</span> <span class="nf">terminal_split</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">uuid</span><span class="p">,</span> <span class="n">horiz</span><span class="p">):</span>
258
<span class="sd">"""Split a terminal horizontally or vertically, by UUID"""</span>
259
<span class="n">dbg</span><span class="p">(</span><span class="s">'dbus method called: terminal_hsplit'</span><span class="p">)</span>
260
<span class="k">if</span> <span class="ow">not</span> <span class="n">uuid</span><span class="p">:</span>
261
<span class="k">return</span> <span class="s">"ERROR: No UUID specified"</span>
262
<span class="n">terminal</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">terminator</span><span class="o">.</span><span class="n">find_terminal_by_uuid</span><span class="p">(</span><span class="n">uuid</span><span class="p">)</span>
263
<span class="k">if</span> <span class="ow">not</span> <span class="n">terminal</span><span class="p">:</span>
264
<span class="k">return</span> <span class="s">"ERROR: Terminal with supplied UUID not found"</span>
265
<span class="k">if</span> <span class="n">horiz</span><span class="p">:</span>
266
<span class="n">terminal</span><span class="o">.</span><span class="n">key_split_horiz</span><span class="p">()</span>
267
<span class="k">else</span><span class="p">:</span>
268
<span class="n">terminal</span><span class="o">.</span><span class="n">key_split_vert</span><span class="p">()</span>
270
<span class="nd">@dbus.service.method</span><span class="p">(</span><span class="n">BUS_NAME</span><span class="p">)</span>
271
<div class="viewcode-block" id="DBusService.get_terminals"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.ipc.DBusService.get_terminals">[docs]</a> <span class="k">def</span> <span class="nf">get_terminals</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">uuid</span><span class="p">):</span>
272
<span class="sd">"""Return a list of all the terminals"""</span>
273
<span class="k">return</span> <span class="p">[</span><span class="n">x</span><span class="o">.</span><span class="n">uuid</span><span class="o">.</span><span class="n">urn</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">terminator</span><span class="o">.</span><span class="n">terminals</span><span class="p">]</span>
275
<span class="nd">@dbus.service.method</span><span class="p">(</span><span class="n">BUS_NAME</span><span class="p">)</span>
276
<div class="viewcode-block" id="DBusService.get_terminal_tab"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.ipc.DBusService.get_terminal_tab">[docs]</a> <span class="k">def</span> <span class="nf">get_terminal_tab</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">uuid</span><span class="p">):</span>
277
<span class="sd">"""Return the UUID of the parent tab of a given terminal"""</span>
278
<span class="n">maker</span> <span class="o">=</span> <span class="n">Factory</span><span class="p">()</span>
279
<span class="n">terminal</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">terminator</span><span class="o">.</span><span class="n">find_terminal_by_uuid</span><span class="p">(</span><span class="n">uuid</span><span class="p">)</span>
280
<span class="n">window</span> <span class="o">=</span> <span class="n">terminal</span><span class="o">.</span><span class="n">get_toplevel</span><span class="p">()</span>
281
<span class="n">root_widget</span> <span class="o">=</span> <span class="n">window</span><span class="o">.</span><span class="n">get_children</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span>
282
<span class="k">if</span> <span class="n">maker</span><span class="o">.</span><span class="n">isinstance</span><span class="p">(</span><span class="n">root_widget</span><span class="p">,</span> <span class="s">'Notebook'</span><span class="p">):</span>
283
<span class="k">return</span> <span class="n">root_widget</span><span class="o">.</span><span class="n">uuid</span><span class="o">.</span><span class="n">urn</span>
285
<span class="nd">@dbus.service.method</span><span class="p">(</span><span class="n">BUS_NAME</span><span class="p">)</span>
286
<div class="viewcode-block" id="DBusService.get_terminal_tab_title"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.ipc.DBusService.get_terminal_tab_title">[docs]</a> <span class="k">def</span> <span class="nf">get_terminal_tab_title</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">uuid</span><span class="p">):</span>
287
<span class="sd">"""Return the title of a parent tab of a given terminal"""</span>
288
<span class="n">maker</span> <span class="o">=</span> <span class="n">Factory</span><span class="p">()</span>
289
<span class="n">terminal</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">terminator</span><span class="o">.</span><span class="n">find_terminal_by_uuid</span><span class="p">(</span><span class="n">uuid</span><span class="p">)</span>
290
<span class="n">window</span> <span class="o">=</span> <span class="n">terminal</span><span class="o">.</span><span class="n">get_toplevel</span><span class="p">()</span>
291
<span class="n">root_widget</span> <span class="o">=</span> <span class="n">window</span><span class="o">.</span><span class="n">get_children</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span>
292
<span class="k">if</span> <span class="n">maker</span><span class="o">.</span><span class="n">isinstance</span><span class="p">(</span><span class="n">root_widget</span><span class="p">,</span> <span class="s">"Notebook"</span><span class="p">):</span>
293
<span class="k">return</span> <span class="n">root_widget</span><span class="o">.</span><span class="n">get_tab_label</span><span class="p">(</span><span class="n">terminal</span><span class="p">)</span><span class="o">.</span><span class="n">get_label</span><span class="p">()</span>
295
<div class="viewcode-block" id="with_proxy"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.ipc.with_proxy">[docs]</a><span class="k">def</span> <span class="nf">with_proxy</span><span class="p">(</span><span class="n">func</span><span class="p">):</span>
296
<span class="sd">"""Decorator function to connect to the session dbus bus"""</span>
297
<span class="n">dbg</span><span class="p">(</span><span class="s">'dbus client call: </span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="n">func</span><span class="o">.</span><span class="n">func_name</span><span class="p">)</span>
298
<span class="k">def</span> <span class="nf">_exec</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">argd</span><span class="p">):</span>
299
<span class="n">bus</span> <span class="o">=</span> <span class="n">dbus</span><span class="o">.</span><span class="n">SessionBus</span><span class="p">()</span>
300
<span class="n">proxy</span> <span class="o">=</span> <span class="n">bus</span><span class="o">.</span><span class="n">get_object</span><span class="p">(</span><span class="n">BUS_NAME</span><span class="p">,</span> <span class="n">BUS_PATH</span><span class="p">)</span>
301
<span class="n">func</span><span class="p">(</span><span class="n">proxy</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">argd</span><span class="p">)</span>
302
<span class="k">return</span> <span class="n">_exec</span>
304
<span class="nd">@with_proxy</span>
305
<div class="viewcode-block" id="new_window"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.ipc.new_window">[docs]</a><span class="k">def</span> <span class="nf">new_window</span><span class="p">(</span><span class="n">session</span><span class="p">,</span> <span class="n">options</span><span class="p">):</span>
306
<span class="sd">"""Call the dbus method to open a new window"""</span>
307
<span class="n">session</span><span class="o">.</span><span class="n">new_window</span><span class="p">(</span><span class="n">options</span><span class="p">)</span>
309
<span class="nd">@with_proxy</span>
310
<div class="viewcode-block" id="new_tab"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.ipc.new_tab">[docs]</a><span class="k">def</span> <span class="nf">new_tab</span><span class="p">(</span><span class="n">session</span><span class="p">,</span> <span class="n">options</span><span class="p">):</span>
311
<span class="sd">"""Call the dbus method to open a new tab in the first window"""</span>
312
<span class="n">session</span><span class="o">.</span><span class="n">new_tab</span><span class="p">(</span><span class="n">options</span><span class="p">)</span>
314
<span class="nd">@with_proxy</span>
315
<div class="viewcode-block" id="terminal_hsplit"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.ipc.terminal_hsplit">[docs]</a><span class="k">def</span> <span class="nf">terminal_hsplit</span><span class="p">(</span><span class="n">session</span><span class="p">,</span> <span class="n">uuid</span><span class="p">):</span>
316
<span class="sd">"""Call the dbus method to horizontally split a terminal"""</span>
317
<span class="n">session</span><span class="o">.</span><span class="n">terminal_hsplit</span><span class="p">(</span><span class="n">uuid</span><span class="p">)</span>
319
<span class="nd">@with_proxy</span>
320
<div class="viewcode-block" id="terminal_vsplit"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.ipc.terminal_vsplit">[docs]</a><span class="k">def</span> <span class="nf">terminal_vsplit</span><span class="p">(</span><span class="n">session</span><span class="p">,</span> <span class="n">uuid</span><span class="p">):</span>
321
<span class="sd">"""Call the dbus method to vertically split a terminal"""</span>
322
<span class="k">print</span> <span class="n">session</span><span class="o">.</span><span class="n">terminal_vsplit</span><span class="p">(</span><span class="n">uuid</span><span class="p">)</span>
324
<span class="nd">@with_proxy</span>
325
<div class="viewcode-block" id="get_terminals"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.ipc.get_terminals">[docs]</a><span class="k">def</span> <span class="nf">get_terminals</span><span class="p">(</span><span class="n">session</span><span class="p">,</span> <span class="n">uuid</span><span class="p">):</span>
326
<span class="sd">"""Call the dbus method to return a list of all terminals"""</span>
327
<span class="k">print</span> <span class="s">'</span><span class="se">\n</span><span class="s">'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">session</span><span class="o">.</span><span class="n">get_terminals</span><span class="p">(</span><span class="n">uuid</span><span class="p">))</span>
329
<span class="nd">@with_proxy</span>
330
<div class="viewcode-block" id="get_terminal_tab"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.ipc.get_terminal_tab">[docs]</a><span class="k">def</span> <span class="nf">get_terminal_tab</span><span class="p">(</span><span class="n">session</span><span class="p">,</span> <span class="n">uuid</span><span class="p">):</span>
331
<span class="sd">"""Call the dbus method to return the toplevel tab for a terminal"""</span>
332
<span class="k">print</span> <span class="n">session</span><span class="o">.</span><span class="n">get_terminal_tab</span><span class="p">(</span><span class="n">uuid</span><span class="p">)</span>
334
<span class="nd">@with_proxy</span>
335
<div class="viewcode-block" id="get_terminal_tab_title"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.ipc.get_terminal_tab_title">[docs]</a><span class="k">def</span> <span class="nf">get_terminal_tab_title</span><span class="p">(</span><span class="n">session</span><span class="p">,</span> <span class="n">uuid</span><span class="p">):</span>
336
<span class="sd">"""Call the dbus method to return the title of a tab"""</span>
337
<span class="k">print</span> <span class="n">session</span><span class="o">.</span><span class="n">get_terminal_tab_title</span><span class="p">(</span><span class="n">uuid</span><span class="p">)</span>
346
<div role="contentinfo">
348
© Copyright 2015, Stephen Boddy, licensed under the CC-BY-SA..
351
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
366
<script type="text/javascript">
367
var DOCUMENTATION_OPTIONS = {
370
COLLAPSE_INDEX:false,
375
<script type="text/javascript" src="../../_static/jquery.js"></script>
376
<script type="text/javascript" src="../../_static/underscore.js"></script>
377
<script type="text/javascript" src="../../_static/doctools.js"></script>
383
<script type="text/javascript" src="../../_static/js/theme.js"></script>
388
<script type="text/javascript">
390
SphinxRtdTheme.StickyNav.enable();
b'\\ No newline at end of file'
added
removed
doc/apidoc/_build/html/_modules/terminatorlib/ipc.html
