terminator/doc/apidoc/_build/html/_modules/terminatorlib/ipc.html

396 lines
39 KiB
HTML

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>terminatorlib.ipc &mdash; terminatorlib 0.98 documentation</title>
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="top" title="terminatorlib 0.98 documentation" href="../../index.html"/>
<link rel="up" title="Module code" href="../index.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-nav-search">
<a href="../../index.html" class="icon icon-home"> terminatorlib
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../terminatorlib.html">terminatorlib package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../terminatorlib.configobj.html">terminatorlib.configobj package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.configobj.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.configobj.html#module-terminatorlib.configobj.configobj">terminatorlib.configobj.configobj module</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.configobj.html#module-terminatorlib.configobj.validate">terminatorlib.configobj.validate module</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.configobj.html#module-terminatorlib.configobj">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../../terminatorlib.plugins.html">terminatorlib.plugins package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins.activitywatch">terminatorlib.plugins.activitywatch module</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins.custom_commands">terminatorlib.plugins.custom_commands module</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins.logger">terminatorlib.plugins.logger module</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins.maven">terminatorlib.plugins.maven module</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins.terminalshot">terminatorlib.plugins.terminalshot module</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins.testplugin">terminatorlib.plugins.testplugin module</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins.url_handlers">terminatorlib.plugins.url_handlers module</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins">Module contents</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.borg">terminatorlib.borg module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.config">terminatorlib.config module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.container">terminatorlib.container module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.cwd">terminatorlib.cwd module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.debugserver">terminatorlib.debugserver module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.editablelabel">terminatorlib.editablelabel module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.encoding">terminatorlib.encoding module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.factory">terminatorlib.factory module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.freebsd">terminatorlib.freebsd module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.ipc">terminatorlib.ipc module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.keybindings">terminatorlib.keybindings module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.layoutlauncher">terminatorlib.layoutlauncher module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.notebook">terminatorlib.notebook module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.optionparse">terminatorlib.optionparse module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.paned">terminatorlib.paned module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.plugin">terminatorlib.plugin module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.prefseditor">terminatorlib.prefseditor module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.searchbar">terminatorlib.searchbar module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.signalman">terminatorlib.signalman module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.terminal">terminatorlib.terminal module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.terminal_popup_menu">terminatorlib.terminal_popup_menu module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.terminator">terminatorlib.terminator module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.titlebar">terminatorlib.titlebar module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.translation">terminatorlib.translation module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.util">terminatorlib.util module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.version">terminatorlib.version module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.window">terminatorlib.window module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib">Module contents</a></li>
</ul>
</li>
</ul>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">terminatorlib</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html">Docs</a> &raquo;</li>
<li><a href="../index.html">Module code</a> &raquo;</li>
<li>terminatorlib.ipc</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document">
<h1>Source code for terminatorlib.ipc</h1><div class="highlight"><pre>
<span class="c">#!/usr/bin/python</span>
<span class="c"># Terminator by Chris Jones &lt;cmsj@tenshu.net&gt;</span>
<span class="c"># GPL v2 only</span>
<span class="sd">&quot;&quot;&quot;ipc.py - DBus server and API calls&quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">gtk</span>
<span class="kn">import</span> <span class="nn">dbus.service</span>
<span class="kn">from</span> <span class="nn">dbus.exceptions</span> <span class="kn">import</span> <span class="n">DBusException</span>
<span class="kn">import</span> <span class="nn">dbus.glib</span>
<span class="kn">from</span> <span class="nn">borg</span> <span class="kn">import</span> <span class="n">Borg</span>
<span class="kn">from</span> <span class="nn">terminator</span> <span class="kn">import</span> <span class="n">Terminator</span>
<span class="kn">from</span> <span class="nn">config</span> <span class="kn">import</span> <span class="n">Config</span>
<span class="kn">from</span> <span class="nn">factory</span> <span class="kn">import</span> <span class="n">Factory</span>
<span class="kn">from</span> <span class="nn">util</span> <span class="kn">import</span> <span class="n">dbg</span>
<span class="n">CONFIG</span> <span class="o">=</span> <span class="n">Config</span><span class="p">()</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">CONFIG</span><span class="p">[</span><span class="s">&#39;dbus&#39;</span><span class="p">]:</span>
<span class="c"># The config says we are not to load dbus, so pretend like we can&#39;t</span>
<span class="n">dbg</span><span class="p">(</span><span class="s">&#39;dbus disabled&#39;</span><span class="p">)</span>
<span class="k">raise</span> <span class="ne">ImportError</span>
<span class="n">BUS_BASE</span> <span class="o">=</span> <span class="s">&#39;net.tenshu.Terminator&#39;</span>
<span class="n">BUS_PATH</span> <span class="o">=</span> <span class="s">&#39;/net/tenshu/Terminator&#39;</span>
<span class="k">try</span><span class="p">:</span>
<span class="c"># Try and include the X11 display name in the dbus bus name</span>
<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">&#39;-&#39;</span><span class="p">,</span> <span class="s">&#39;_&#39;</span><span class="p">)</span>
<span class="n">BUS_NAME</span> <span class="o">=</span> <span class="s">&#39;</span><span class="si">%s%s</span><span class="s">&#39;</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>
<span class="k">except</span><span class="p">:</span>
<span class="n">BUS_NAME</span> <span class="o">=</span> <span class="n">BUS_BASE</span>
<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>
<span class="sd">&quot;&quot;&quot;DBus Server class. This is implemented as a Borg&quot;&quot;&quot;</span>
<span class="n">bus_name</span> <span class="o">=</span> <span class="bp">None</span>
<span class="n">bus_path</span> <span class="o">=</span> <span class="bp">None</span>
<span class="n">terminator</span> <span class="o">=</span> <span class="bp">None</span>
<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>
<span class="sd">&quot;&quot;&quot;Class initialiser&quot;&quot;&quot;</span>
<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>
<span class="bp">self</span><span class="o">.</span><span class="n">prepare_attributes</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="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>
</div>
<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>
<span class="sd">&quot;&quot;&quot;Ensure we are populated&quot;&quot;&quot;</span>
<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>
<span class="n">dbg</span><span class="p">(</span><span class="s">&#39;Checking for bus name availability: </span><span class="si">%s</span><span class="s">&#39;</span> <span class="o">%</span> <span class="n">BUS_NAME</span><span class="p">)</span>
<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>
<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">&#39;org.freedesktop.DBus&#39;</span><span class="p">,</span>
<span class="s">&#39;/org/freedesktop/DBus&#39;</span><span class="p">)</span>
<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>
<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>
<span class="n">dbg</span><span class="p">(</span><span class="s">&#39;bus name unavailable: </span><span class="si">%s</span><span class="s">&#39;</span> <span class="o">%</span> <span class="n">BUS_NAME</span><span class="p">)</span>
<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>
<span class="s">&quot;Couldn&#39;t get DBus name </span><span class="si">%s</span><span class="s">: Name exists&quot;</span> <span class="o">%</span> <span class="n">BUS_NAME</span><span class="p">)</span>
<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>
<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>
<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>
<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>
<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>
<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>
</div>
<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">&#39;a{ss}&#39;</span><span class="p">)</span>
<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>
<span class="sd">&quot;&quot;&quot;Create a new Window&quot;&quot;&quot;</span>
<span class="n">dbg</span><span class="p">(</span><span class="s">&#39;dbus method called: new_window with parameters </span><span class="si">%s</span><span class="s">&#39;</span><span class="o">%</span><span class="p">(</span><span class="n">options</span><span class="p">))</span>
<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>
<span class="n">oldopts</span><span class="o">.</span><span class="n">__dict__</span> <span class="o">=</span> <span class="n">options</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_set</span><span class="p">(</span><span class="n">oldopts</span><span class="p">)</span>
<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>
<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>
</div>
<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">&#39;a{ss}&#39;</span><span class="p">)</span>
<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>
<span class="sd">&quot;&quot;&quot;Create a new tab&quot;&quot;&quot;</span>
<span class="n">dbg</span><span class="p">(</span><span class="s">&#39;dbus method called: new_tab with parameters </span><span class="si">%s</span><span class="s">&#39;</span><span class="o">%</span><span class="p">(</span><span class="n">options</span><span class="p">))</span>
<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>
<span class="n">oldopts</span><span class="o">.</span><span class="n">__dict__</span> <span class="o">=</span> <span class="n">options</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_set</span><span class="p">(</span><span class="n">oldopts</span><span class="p">)</span>
<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>
<span class="n">window</span><span class="o">.</span><span class="n">tab_new</span><span class="p">()</span>
</div>
<span class="nd">@dbus.service.method</span><span class="p">(</span><span class="n">BUS_NAME</span><span class="p">)</span>
<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>
<span class="sd">&quot;&quot;&quot;Split a terminal horizontally, by UUID&quot;&quot;&quot;</span>
<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>
</div>
<span class="nd">@dbus.service.method</span><span class="p">(</span><span class="n">BUS_NAME</span><span class="p">)</span>
<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>
<span class="sd">&quot;&quot;&quot;Split a terminal vertically, by UUID&quot;&quot;&quot;</span>
<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>
</div>
<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>
<span class="sd">&quot;&quot;&quot;Split a terminal horizontally or vertically, by UUID&quot;&quot;&quot;</span>
<span class="n">dbg</span><span class="p">(</span><span class="s">&#39;dbus method called: terminal_hsplit&#39;</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">uuid</span><span class="p">:</span>
<span class="k">return</span> <span class="s">&quot;ERROR: No UUID specified&quot;</span>
<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>
<span class="k">if</span> <span class="ow">not</span> <span class="n">terminal</span><span class="p">:</span>
<span class="k">return</span> <span class="s">&quot;ERROR: Terminal with supplied UUID not found&quot;</span>
<span class="k">if</span> <span class="n">horiz</span><span class="p">:</span>
<span class="n">terminal</span><span class="o">.</span><span class="n">key_split_horiz</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">terminal</span><span class="o">.</span><span class="n">key_split_vert</span><span class="p">()</span>
</div>
<span class="nd">@dbus.service.method</span><span class="p">(</span><span class="n">BUS_NAME</span><span class="p">)</span>
<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>
<span class="sd">&quot;&quot;&quot;Return a list of all the terminals&quot;&quot;&quot;</span>
<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>
</div>
<span class="nd">@dbus.service.method</span><span class="p">(</span><span class="n">BUS_NAME</span><span class="p">)</span>
<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>
<span class="sd">&quot;&quot;&quot;Return the UUID of the parent tab of a given terminal&quot;&quot;&quot;</span>
<span class="n">maker</span> <span class="o">=</span> <span class="n">Factory</span><span class="p">()</span>
<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>
<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>
<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>
<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">&#39;Notebook&#39;</span><span class="p">):</span>
<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>
</div>
<span class="nd">@dbus.service.method</span><span class="p">(</span><span class="n">BUS_NAME</span><span class="p">)</span>
<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>
<span class="sd">&quot;&quot;&quot;Return the title of a parent tab of a given terminal&quot;&quot;&quot;</span>
<span class="n">maker</span> <span class="o">=</span> <span class="n">Factory</span><span class="p">()</span>
<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>
<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>
<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>
<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">&quot;Notebook&quot;</span><span class="p">):</span>
<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>
</div></div>
<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>
<span class="sd">&quot;&quot;&quot;Decorator function to connect to the session dbus bus&quot;&quot;&quot;</span>
<span class="n">dbg</span><span class="p">(</span><span class="s">&#39;dbus client call: </span><span class="si">%s</span><span class="s">&#39;</span> <span class="o">%</span> <span class="n">func</span><span class="o">.</span><span class="n">func_name</span><span class="p">)</span>
<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>
<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>
<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>
<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>
<span class="k">return</span> <span class="n">_exec</span>
</div>
<span class="nd">@with_proxy</span>
<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>
<span class="sd">&quot;&quot;&quot;Call the dbus method to open a new window&quot;&quot;&quot;</span>
<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>
</div>
<span class="nd">@with_proxy</span>
<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>
<span class="sd">&quot;&quot;&quot;Call the dbus method to open a new tab in the first window&quot;&quot;&quot;</span>
<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>
</div>
<span class="nd">@with_proxy</span>
<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>
<span class="sd">&quot;&quot;&quot;Call the dbus method to horizontally split a terminal&quot;&quot;&quot;</span>
<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>
</div>
<span class="nd">@with_proxy</span>
<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>
<span class="sd">&quot;&quot;&quot;Call the dbus method to vertically split a terminal&quot;&quot;&quot;</span>
<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>
</div>
<span class="nd">@with_proxy</span>
<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>
<span class="sd">&quot;&quot;&quot;Call the dbus method to return a list of all terminals&quot;&quot;&quot;</span>
<span class="k">print</span> <span class="s">&#39;</span><span class="se">\n</span><span class="s">&#39;</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>
</div>
<span class="nd">@with_proxy</span>
<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>
<span class="sd">&quot;&quot;&quot;Call the dbus method to return the toplevel tab for a terminal&quot;&quot;&quot;</span>
<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>
</div>
<span class="nd">@with_proxy</span>
<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>
<span class="sd">&quot;&quot;&quot;Call the dbus method to return the title of a tab&quot;&quot;&quot;</span>
<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>
</pre></div></div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2015, Stephen Boddy, licensed under the CC-BY-SA..
</p>
</div>
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>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
VERSION:'0.98',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>