1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
# This file is part of the Frescobaldi project, http://www.frescobaldi.org/
#
# Copyright (c) 2008 - 2014 by Wilbert Berendsen
#
# 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, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
# See http://www.gnu.org/licenses/ for more information.
"""
Store meta information about documents.
"""
import time
from PyQt5.QtCore import QSettings, QUrl
import app
import plugin
__all__ = ["info", "define"]
# This dictionary store the default values: "name": [default, readfunc]
_defaults = {}
def info(document):
"""Returns a MetaInfo object for the Document."""
return MetaInfo.instance(document)
def define(name, default, readfunc=None):
"""Define a variable and its default value to be stored in the metainfo.
Should be defined before it is requested or set.
If readfunc is not given it defaults to a suitable function for bool or int types.
"""
if readfunc is None:
if isinstance(default, bool):
if default:
readfunc = lambda v: v not in ('false', False)
else:
readfunc = lambda v: v not in ('true', True)
elif isinstance(default, int):
readfunc = int
else:
readfunc = lambda v: v
_defaults[name] = [default, readfunc]
# read this value for already loaded metainfo items
for minfo in MetaInfo.instances():
minfo.loadValue(name)
class MetaInfo(plugin.DocumentPlugin):
"""Stores meta-information for a Document."""
def __init__(self, document):
self.load()
document.loaded.connect(self.load, -999) # before all others
document.closed.connect(self.save, 999) # after all others
def settingsGroup(self):
url = self.document().url()
if not url.isEmpty():
s = app.settings('metainfo')
s.beginGroup(url.toString().replace('\\', '_').replace('/', '_'))
return s
def load(self):
s = self.settingsGroup()
for name in _defaults:
self.loadValue(name, s)
def loadValue(self, name, settings=None):
s = settings or self.settingsGroup()
default, readfunc = _defaults[name]
if s and QSettings().value("metainfo", True, bool):
self.__dict__[name] = readfunc(s.value(name, default))
else:
self.__dict__[name] = default
def save(self):
s = self.settingsGroup()
if s:
s.setValue("time", time.time())
for name in _defaults:
value = self.__dict__[name]
s.remove(name) if value == _defaults[name][0] else s.setValue(name, value)
@app.aboutToQuit.connect
def prune():
"""Prune old info."""
s = app.settings('metainfo')
month_ago = time.time() - 31 * 24 * 3600
for key in s.childGroups():
if s.value(key + "/time", 0.0, float) < month_ago:
s.remove(key)
|
