/* jslint esversion: 6 */ /* * Copyright 2019 Abakkk * * This file is part of DrowOnYourScreen, a drawing extension for GNOME Shell. * https://framagit.org/abakkk/DrawOnYourScreen * * This program 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 2 of the License, or * (at your option) any later version. * * This program 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 . */ const Cairo = imports.cairo; const Clutter = imports.gi.Clutter; const GLib = imports.gi.GLib; const Gtk = imports.gi.Gtk; const Lang = imports.lang; const Mainloop = imports.mainloop; const Signals = imports.signals; const St = imports.gi.St; const Screenshot = imports.ui.screenshot; const Tweener = imports.ui.tweener; const ExtensionUtils = imports.misc.extensionUtils; const Extension = ExtensionUtils.getCurrentExtension(); const Convenience = Extension.imports.convenience; const Prefs = Extension.imports.prefs; const _ = imports.gettext.domain(Extension.metadata["gettext-domain"]).gettext; var Shapes = { NONE: 0, LINE: 1, ELLIPSE: 2, RECTANGLE: 3, TEXT: 4 }; var ShapeNames = { 0: "Free drawing", 1: "Line", 2: "Circle", 3: "Rectangle", 4: "Text" }; var LineCapNames = { 0: 'Butt', 1: 'Round', 2: 'Square' }; var LineJoinNames = { 0: 'Miter', 1: 'Round', 2: 'Bevel' }; var FontWeightNames = { 0: 'Normal', 1: 'Bold' }; var FontStyleNames = { 0: 'Normal', 1: 'Italic', 2: 'Oblique' }; var FontFamilyNames = { 0: 'Default', 1: 'Sans-Serif', 2: 'Serif', 3: 'Monospace', 4: 'Cursive', 5: 'Fantasy' }; // DrawingArea is the widget in which we draw, thanks to Cairo. // It creates and manages a DrawingElement for each "brushstroke". // It handles pointer/mouse/(touch?) events and some keyboard events. var DrawingArea = new Lang.Class({ Name: 'DrawingArea', Extends: St.DrawingArea, _init: function(params, helper) { this.parent({ style_class: 'draw-on-your-screen', name: params && params.name ? params.name : ""}); // 'style-changed' is emitted when 'this' is added to an actor // ('this' needs to be in the stage to query theme_node) this.connect('style-changed', this._onStyleChanged.bind(this)); this.connect('repaint', this._repaint.bind(this)); this.emitter = new DrawingAreaEmitter(); this.helper = helper; this.elements = []; this.undoneElements = []; this.currentElement = null; this.currentShape = Shapes.NONE; this.hasBackground = false; this.textHasCursor = false; this.dashedLine = false; this.colors = [Clutter.Color.new(0, 0, 0, 255)]; }, _redisplay: function() { // force area to emit 'repaint' this.queue_repaint(); }, _onStyleChanged: function() { try { let themeNode = this.get_theme_node(); for (let i = 1; i < 10; i++) { this.colors[i] = themeNode.get_color('-drawing-color' + i); } this.activeBackgroundColor = themeNode.get_color('-drawing-background-color'); this.currentLineWidth = themeNode.get_length('-drawing-line-width'); this.currentLineJoin = themeNode.get_double('-drawing-line-join'); this.currentLineCap = themeNode.get_double('-drawing-line-cap'); this.dashArray = [themeNode.get_length('-drawing-dash-array-on'), themeNode.get_length('-drawing-dash-array-off')]; this.dashOffset = themeNode.get_length('-drawing-dash-offset'); let font = themeNode.get_font(); this.fontFamily = font.get_family(); this.currentFontWeight = font.get_weight(); this.currentFontStyle = font.get_style(); } catch(e) { logError(e); } for (let i = 1; i < 10; i++) { this.colors[i] = this.colors[i].alpha ? this.colors[i] : this.colors[0]; } this.currentColor = this.colors[1]; this.currentLineWidth = (this.currentLineWidth > 0) ? this.currentLineWidth : 3; this.currentLineJoin = ([0, 1, 2].indexOf(this.currentLineJoin) != -1) ? this.currentLineJoin : Cairo.LineJoin.ROUND; this.currentLineCap = ([0, 1, 2].indexOf(this.currentLineCap) != -1) ? this.currentLineCap : Cairo.LineCap.ROUND; this.currentFontFamilyId = 0; this.currentFontWeight = this.currentFontWeight > 500 ? 1 : 0 ; // font style enum order of Cairo and Pango are different this.currentFontStyle = this.currentFontStyle == 2 ? 1 : ( this.currentFontStyle == 1 ? 2 : 0); }, _repaint: function(area) { let cr = area.get_context(); for (let i = 0; i < this.elements.length; i++) { this.elements[i].buildCairo(cr, false); if (this.elements[i].fill && this.elements[i].shape != Shapes.LINE) cr.fill(); else cr.stroke(); } if (this.currentElement) { this.currentElement.buildCairo(cr, this.textHasCursor); cr.stroke(); } cr.$dispose(); }, _onButtonPressed: function(actor, event) { let button = event.get_button(); let [x, y] = event.get_coords(); let shiftPressed = event.has_shift_modifier(); // stop writing if (this.currentElement && this.currentElement.shape == Shapes.TEXT) { this._stopWriting(); } // hide helper if (this.helper.visible && button != 2) { this.helper.hideHelp(); return Clutter.EVENT_STOP; } if (button == 1) { this._startDrawing(x, y, false, shiftPressed); return Clutter.EVENT_STOP; } else if (button == 2) { this.toggleShape(); } else if (button == 3) { this._startDrawing(x, y, true, shiftPressed); return Clutter.EVENT_STOP; } return Clutter.EVENT_PROPAGATE; }, _onKeyPressed: function(actor, event) { if (event.get_key_symbol() == Clutter.Escape) { this.emitter.emit('stop-drawing'); this.erase(); return Clutter.EVENT_STOP; } else if (this.currentElement && this.currentElement.shape == Shapes.TEXT) { if (event.get_key_symbol() == Clutter.KEY_BackSpace) { this.currentElement.text = this.currentElement.text.slice(0, -1); this._updateCursorTimeout(); } else if (event.has_control_modifier() && event.get_key_symbol() == 118) { // Ctrl + V St.Clipboard.get_default().get_text(St.ClipboardType.CLIPBOARD, (clipBoard, clipText) => { this.currentElement.text += clipText; this._updateCursorTimeout(); this._redisplay(); }); return Clutter.EVENT_STOP; } else if (event.get_key_symbol() == Clutter.KEY_Return || event.get_key_symbol() == 65421) { // stop writing // Clutter.KEY_Return is "Enter" and 65421 is KP_Enter this._stopWriting(); } else { let unicode = event.get_key_unicode(); this.currentElement.text += unicode; this._updateCursorTimeout(); } this._redisplay(); return Clutter.EVENT_STOP; } else { return Clutter.EVENT_PROPAGATE; } }, _onScroll: function(actor, event) { if (this.helper.visible) return Clutter.EVENT_PROPAGATE; let direction = event.get_scroll_direction(); if (direction == Clutter.ScrollDirection.UP) this.incrementLineWidth(1); else if (direction == Clutter.ScrollDirection.DOWN) this.incrementLineWidth(-1); else return Clutter.EVENT_PROPAGATE; return Clutter.EVENT_STOP; }, _startDrawing: function(stageX, stageY, fill, eraser) { let [success, startX, startY] = this.transform_stage_point(stageX, stageY); if (!success) return; this.buttonReleasedHandler = this.connect('button-release-event', (actor, event) => { this._stopDrawing(); }); this.currentElement = new DrawingElement ({ color: this.currentColor, line: { lineWidth: this.currentLineWidth, lineJoin: this.currentLineJoin, lineCap: this.currentLineCap }, dash: { array: this.dashedLine ? this.dashArray : [0, 0] , offset: this.dashedLine ? this.dashOffset : 0 }, fill: fill, eraser: eraser, shape: this.currentShape == Shapes.TEXT ? Shapes.RECTANGLE : this.currentShape, text: '', font: { family: (this.currentFontFamilyId == 0 ? this.fontFamily : FontFamilyNames[this.currentFontFamilyId]), weight: this.currentFontWeight, style: this.currentFontStyle }, points: [[startX, startY]] }); this.motionHandler = this.connect('motion-event', (actor, event) => { let coords = event.get_coords(); let [s, x, y] = this.transform_stage_point(coords[0], coords[1]); if (!s) return; this._updateDrawing(x, y); }); }, _stopDrawing: function() { if (this.motionHandler) { this.disconnect(this.motionHandler); this.motionHandler = null; } if (this.buttonReleasedHandler) { this.disconnect(this.buttonReleasedHandler); this.buttonReleasedHandler = null; } // start writing if (this.currentShape == Shapes.TEXT && this.currentElement) { this.currentElement.shape = Shapes.TEXT; this.currentElement.text = ''; this.emitter.emit('show-osd', _("Type your text\nand press Enter"), null); this._updateCursorTimeout(); this._redisplay(); return; } if (this.currentElement) { this.elements.push(this.currentElement); } this.currentElement = null; this._redisplay(); }, _updateDrawing: function(x, y) { if (!this.currentElement) return; if (this.currentElement.shape == Shapes.NONE) this.currentElement.points.push([x, y]); else this.currentElement.points[1] = [x, y]; this._redisplay(); }, _stopWriting: function() { this.elements.push(this.currentElement); this.currentElement = null; this._stopCursorTimeout(); this._redisplay(); }, _stopCursorTimeout: function() { if (this.cursorTimeoutId) { Mainloop.source_remove(this.cursorTimeoutId); this.cursorTimeoutId = null; } this.textHasCursor = false; }, _updateCursorTimeout: function() { this._stopCursorTimeout(); this.cursorTimeoutId = Mainloop.timeout_add(600, () => { this.textHasCursor = !this.textHasCursor; this._redisplay(); return true; }); }, erase: function() { this.elements = []; this.undoneElements = []; this.currentElement = null; this._redisplay(); }, deleteLastElement: function() { if (this.currentElement) { if (this.motionHandler) { this.disconnect(this.motionHandler); this.motionHandler = null; } if (this.buttonReleasedHandler) { this.disconnect(this.buttonReleasedHandler); this.buttonReleasedHandler = null; } this.currentElement = null; this._stopCursorTimeout(); } else { this.elements.pop(); } this._redisplay(); }, undo: function() { if (this.elements.length > 0) this.undoneElements.push(this.elements.pop()); this._redisplay(); }, redo: function() { if (this.undoneElements.length > 0) this.elements.push(this.undoneElements.pop()); this._redisplay(); }, toggleBackground: function() { this.hasBackground = !this.hasBackground; this.get_parent().set_background_color(this.hasBackground ? this.activeBackgroundColor : null); }, toggleColor: function() { this.selectColor((this.currentColor == this.colors[1]) ? 2 : 1); }, selectColor: function(index) { this.currentColor = this.colors[index]; if (this.currentElement) { this.currentElement.color = this.currentColor; this._redisplay(); } this.emitter.emit('show-osd', this.currentColor.to_string(), null); }, selectShape: function(shape) { this.currentShape = shape; this.emitter.emit('show-osd', _(ShapeNames[shape]), null); }, toggleShape: function() { this.selectShape((this.currentShape == Object.keys(Shapes).length - 1) ? 0 : this.currentShape + 1); }, toggleDash: function() { this.dashedLine = !this.dashedLine; this.emitter.emit('show-osd', this.dashedLine ? _("Dashed line") : _("Full line"), null); }, incrementLineWidth: function(increment) { this.currentLineWidth = Math.max(this.currentLineWidth + increment, 1); this.emitter.emit('show-osd', this.currentLineWidth + "px", this.currentLineWidth); }, toggleLineJoin: function() { this.currentLineJoin = this.currentLineJoin == 2 ? 0 : this.currentLineJoin + 1; this.emitter.emit('show-osd', LineJoinNames[this.currentLineJoin], null); }, toggleLineCap: function() { this.currentLineCap = this.currentLineCap == 2 ? 0 : this.currentLineCap + 1; this.emitter.emit('show-osd', LineCapNames[this.currentLineCap], null); }, toggleFontWeight: function() { this.currentFontWeight = this.currentFontWeight == 1 ? 0 : this.currentFontWeight + 1; if (this.currentElement) { this.currentElement.font.weight = this.currentFontWeight; this._redisplay(); } this.emitter.emit('show-osd', FontWeightNames[this.currentFontWeight], null); }, toggleFontStyle: function() { this.currentFontStyle = this.currentFontStyle == 2 ? 0 : this.currentFontStyle + 1; if (this.currentElement) { this.currentElement.font.style = this.currentFontStyle; this._redisplay(); } this.emitter.emit('show-osd', FontStyleNames[this.currentFontStyle], null); }, toggleFontFamily: function() { this.currentFontFamilyId = this.currentFontFamilyId == 5 ? 0 : this.currentFontFamilyId + 1; let currentFontFamily = this.currentFontFamilyId == 0 ? this.fontFamily : FontFamilyNames[this.currentFontFamilyId]; if (this.currentElement) { this.currentElement.font.family = currentFontFamily; this._redisplay(); } this.emitter.emit('show-osd',currentFontFamily , null); }, toggleHelp: function() { if (this.helper.visible) this.helper.hideHelp(); else this.helper.showHelp(); }, enterDrawingMode: function() { this.keyPressedHandler = this.connect('key-press-event', this._onKeyPressed.bind(this)); this.buttonPressedHandler = this.connect('button-press-event', this._onButtonPressed.bind(this)); this.scrollHandler = this.connect('scroll-event', this._onScroll.bind(this)); this.selectShape(Shapes.NONE); this.get_parent().set_background_color(this.hasBackground ? this.activeBackgroundColor : null); }, leaveDrawingMode: function() { if (this.keyPressedHandler) { this.disconnect(this.keyPressedHandler); this.keyPressedHandler = null; } if (this.buttonPressedHandler) { this.disconnect(this.buttonPressedHandler); this.buttonPressedHandler = null; } if (this.motionHandler) { this.disconnect(this.motionHandler); this.motionHandler = null; } if (this.buttonReleasedHandler) { this.disconnect(this.buttonReleasedHandler); this.buttonReleasedHandler = null; } if (this.scrollHandler) { this.disconnect(this.scrollHandler); this.scrollHandler = null; } if (this.helper.visible) this.helper.hideHelp(); this.currentElement = null; this._stopCursorTimeout(); this.dashedLine = false; this._redisplay(); this.get_parent().set_background_color(null); }, save: function() { // stop drawing or writing if (this.currentElement && this.currentElement.shape == Shapes.TEXT) { this._stopWriting(); } else if (this.currentElement && this.currentShape != Shapes.TEXT) { this._stopDrawing(); } let content = ``; let backgroundColorString = this.hasBackground ? this.activeBackgroundColor.to_string() : 'transparent'; if (backgroundColorString != 'transparent') { content += `\n `; } for (let i = 0; i < this.elements.length; i++) { content += this.elements[i].buildSVG(backgroundColorString); } content += "\n"; let date = GLib.DateTime.new_now_local(); let filename = `DrawOnYourScreen ${date.format("%F")} ${date.format("%X")}.svg`; let dir = GLib.get_user_special_dir(GLib.UserDirectory.DIRECTORY_PICTURES); let path = GLib.build_filenamev([dir, filename]); if (GLib.file_test(path, GLib.FileTest.EXISTS)) return false; let success = GLib.file_set_contents(path, content); if (success) { // pass the parent (bgContainer) to Flashspot because coords of this are relative let flashspot = new Screenshot.Flashspot(this.get_parent()); flashspot.fire(); global.play_theme_sound(0, 'screen-capture', "Save as SVG", null); } }, disable: function() { if (this.theme && this.customStylesheetsChangedHandler) { this.theme.disconnect(this.customStylesheetsChangedHandler); this.customStylesheetsChangedHandler = null; } this.erase(); } }); var DrawingAreaEmitter = new Lang.Class({ Name: 'DrawingAreaEmitter', _init: function() { } }); Signals.addSignalMethods(DrawingAreaEmitter.prototype); // DrawingElement represents a "brushstroke". // It can be converted into a cairo path as well as a svg element. // See DrawingArea._startDrawing() to know its params. var DrawingElement = new Lang.Class({ Name: 'DrawingElement', _init: function(params) { for (let key in params) this[key] = params[key]; }, buildCairo: function(cr, showTextCursor) { cr.setLineCap(this.line.lineCap); cr.setLineJoin(this.line.lineJoin); cr.setLineWidth(this.line.lineWidth); if (this.dash.array[0] > 0 && this.dash.array[1] > 0) cr.setDash(this.dash.array, this.dash.offset); else cr.setDash([1000000], 0); if (this.eraser) cr.setOperator(Cairo.Operator.CLEAR); else cr.setOperator(Cairo.Operator.OVER); Clutter.cairo_set_source_color(cr, this.color); let [points, shape] = [this.points, this.shape]; if (shape == Shapes.NONE || shape == Shapes.LINE) { cr.moveTo(points[0][0], points[0][1]); for (let j = 1; j < points.length; j++) { cr.lineTo(points[j][0], points[j][1]); } } else if (shape == Shapes.ELLIPSE && points.length == 2) { let r = Math.hypot(points[1][0] - points[0][0], points[1][1] - points[0][1]); cr.arc(points[0][0], points[0][1], r, 0, 2 * Math.PI); } else if (shape == Shapes.RECTANGLE && points.length == 2) { cr.rectangle(points[0][0], points[0][1], points[1][0] - points[0][0], points[1][1] - points[0][1]); } else if (shape == Shapes.TEXT && points.length == 2) { cr.selectFontFace(this.font.family, this.font.style, this.font.weight); cr.setFontSize(Math.abs(points[1][1] - points[0][1])); cr.moveTo(Math.min(points[0][0], points[1][0]), Math.max(points[0][1], points[1][1])); cr.showText((showTextCursor) ? (this.text + "_") : this.text); } }, buildSVG: function(bgColor) { let row = "\n "; let points = this.points.map((point) => [Math.round(point[0]*100)/100, Math.round(point[1]*100)/100]); let color = this.eraser ? bgColor : this.color.to_string(); let attributes = `fill="${this.fill ? color : 'transparent'}" ` + `stroke="${this.fill ? 'transparent' : color}" ` + `stroke-width="${this.line.lineWidth}" ` + `stroke-linecap="${LineCapNames[this.line.lineCap].toLowerCase()}" ` + `stroke-linejoin="${LineJoinNames[this.line.lineJoin].toLowerCase()}"`; if (this.dash.array[0] > 0 && this.dash.array[1] > 0) attributes += ` stroke-dasharray="${this.dash.array[0]} ${this.dash.array[1]}" stroke-dashoffset="${this.dash.offset}"`; if (this.shape == Shapes.NONE || this.shape == Shapes.LINE) { row += ``; } else if (this.shape == Shapes.ELLIPSE && points.length == 2) { let r = Math.hypot(points[1][0] - points[0][0], points[1][1] - points[0][1]); row += ``; } else if (this.shape == Shapes.RECTANGLE && points.length == 2) { row += ``; } else if (this.shape == Shapes.TEXT && points.length == 2) { attributes = `fill="${color}" ` + `stroke="transparent" ` + `font-family="${this.font.family}" ` + `font-size="${Math.abs(points[1][1] - points[0][1])}" ` + `font-weight="${FontWeightNames[this.font.weight].toLowerCase()}" ` + `font-style="${FontStyleNames[this.font.style].toLowerCase()}"`; row += `${this.text}`; } return row; } }); var HELPER_ANIMATION_TIME = 0.25; // DrawingHelper provides the "help osd" (Ctrl + F1) // It uses the same texts as in prefs var DrawingHelper = new Lang.Class({ Name: 'DrawingHelper', Extends: St.ScrollView, _init: function(params, monitor) { this.parent(params); this.monitor = monitor; this.hide(); this.vbox = new St.BoxLayout({ style_class: 'osd-window draw-on-your-screen-helper', vertical: true }); this.add_actor(this.vbox); this.vbox.add(new St.Label({ text: _("Global") })); let settings = Convenience.getSettings(); for (let settingKey in Prefs.GLOBAL_KEYBINDINGS) { let hbox = new St.BoxLayout({ vertical: false }); if (settingKey.indexOf('-separator-') != -1) { this.vbox.add(hbox); continue; } let [keyval, mods] = Gtk.accelerator_parse(settings.get_strv(settingKey)[0]); hbox.add(new St.Label({ text: _(Prefs.GLOBAL_KEYBINDINGS[settingKey]) })); hbox.add(new St.Label({ text: Gtk.accelerator_get_label(keyval, mods) }), { expand: true }); this.vbox.add(hbox); } this.vbox.add(new St.Label({ text: _("Internal") })); for (let desc in Prefs.OTHER_SHORTCUTS) { if (desc.indexOf('-separator-') != -1) { this.vbox.add(new St.BoxLayout({ vertical: false, style_class: 'draw-on-your-screen-separator' })); continue; } let hbox = new St.BoxLayout({ vertical: false }); hbox.add(new St.Label({ text: _(desc) })); hbox.add(new St.Label({ text: _(Prefs.OTHER_SHORTCUTS[desc]) }), { expand: true }); this.vbox.add(hbox); } this.vbox.add(new St.BoxLayout({ vertical: false, style_class: 'draw-on-your-screen-separator' })); for (let settingKey in Prefs.INTERNAL_KEYBINDINGS) { if (settingKey.indexOf('-separator-') != -1) { this.vbox.add(new St.BoxLayout({ vertical: false, style_class: 'draw-on-your-screen-separator' })); continue; } let hbox = new St.BoxLayout({ vertical: false }); let [keyval, mods] = Gtk.accelerator_parse(settings.get_strv(settingKey)[0]); hbox.add(new St.Label({ text: _(Prefs.INTERNAL_KEYBINDINGS[settingKey]) })); hbox.add(new St.Label({ text: Gtk.accelerator_get_label(keyval, mods) }), { expand: true }); this.vbox.add(hbox); } }, showHelp: function() { this.opacity = 0; this.show(); let maxHeight = this.monitor.height*(3/4); if (this.height > maxHeight) this.vscrollbar_policy = Gtk.PolicyType.ALWAYS; else this.vscrollbar_policy = Gtk.PolicyType.NEVER; this.set_height(Math.min(this.height, maxHeight)); this.set_position(this.monitor.x + Math.floor(this.monitor.width / 2 - this.width / 2), this.monitor.y + Math.floor(this.monitor.height / 2 - this.height / 2)); Tweener.removeTweens(this); Tweener.addTween(this, { opacity: 255, time: HELPER_ANIMATION_TIME, transition: 'easeOutQuad', onComplete: null }); }, hideHelp: function() { Tweener.removeTweens(this); Tweener.addTween(this, { opacity: 0, time: HELPER_ANIMATION_TIME, transition: 'easeOutQuad', onComplete: this.hide.bind(this) }); }, });