Mercurial > parpg-core

annotate src/parpg/components/lockable.py @ 49:3024ded5ae61

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added functions for Lockable
author KarstenBock@gmx.net
date Fri, 02 Sep 2011 15:57:27 +0200
parents 1cc037593517
children 96af64cf3b81
rev   line source
34
5ac50245e42c Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
1 # This program is free software: you can redistribute it and/or modify
5ac50245e42c Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
2 # it under the terms of the GNU General Public License as published by
5ac50245e42c Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
3 # the Free Software Foundation, either version 3 of the License, or
5ac50245e42c Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
4 # (at your option) any later version.
5ac50245e42c Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
5 #
5ac50245e42c Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
6 # This program is distributed in the hope that it will be useful,
5ac50245e42c Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
7 # but WITHOUT ANY WARRANTY; without even the implied warranty of
5ac50245e42c Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
8 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
5ac50245e42c Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
9 # GNU General Public License for more details.
5ac50245e42c Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
10 #
5ac50245e42c Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
11 # You should have received a copy of the GNU General Public License
5ac50245e42c Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
12 # along with this program. If not, see <http://www.gnu.org/licenses/>.
5ac50245e42c Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
13
5ac50245e42c Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
14 from parpg.grease.component import Component
5ac50245e42c Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
15
5ac50245e42c Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
16 class Lockable(Component):
5ac50245e42c Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
17 """Component that stores the data of a lock"""
49
3024ded5ae61 Added functions for Lockable
KarstenBock@gmx.net
parents: 43
diff changeset
18
34
5ac50245e42c Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
19 def __init__(self):
5ac50245e42c Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
20 """Constructor"""
49
3024ded5ae61 Added functions for Lockable
KarstenBock@gmx.net
parents: 43
diff changeset
21 Component.__init__(self, closed=bool, locked=bool)
3024ded5ae61 Added functions for Lockable
KarstenBock@gmx.net
parents: 43
diff changeset
22
3024ded5ae61 Added functions for Lockable
KarstenBock@gmx.net
parents: 43
diff changeset
23 class LockedError(Exception):
3024ded5ae61 Added functions for Lockable
KarstenBock@gmx.net
parents: 43
diff changeset
24
3024ded5ae61 Added functions for Lockable
KarstenBock@gmx.net
parents: 43
diff changeset
25 def __str__(self):
3024ded5ae61 Added functions for Lockable
KarstenBock@gmx.net
parents: 43
diff changeset
26 return "Is locked"
3024ded5ae61 Added functions for Lockable
KarstenBock@gmx.net
parents: 43
diff changeset
27
3024ded5ae61 Added functions for Lockable
KarstenBock@gmx.net
parents: 43
diff changeset
28 class OpenError(Exception):
3024ded5ae61 Added functions for Lockable
KarstenBock@gmx.net
parents: 43
diff changeset
29
3024ded5ae61 Added functions for Lockable
KarstenBock@gmx.net
parents: 43
diff changeset
30 def __str__(self):
3024ded5ae61 Added functions for Lockable
KarstenBock@gmx.net
parents: 43
diff changeset
31 return "Is open"
3024ded5ae61 Added functions for Lockable
KarstenBock@gmx.net
parents: 43
diff changeset
32
3024ded5ae61 Added functions for Lockable
KarstenBock@gmx.net
parents: 43
diff changeset
33 def lock(lock):
3024ded5ae61 Added functions for Lockable
KarstenBock@gmx.net
parents: 43
diff changeset
34 if not lock.closed:
3024ded5ae61 Added functions for Lockable
KarstenBock@gmx.net
parents: 43
diff changeset
35 raise OpenError
3024ded5ae61 Added functions for Lockable
KarstenBock@gmx.net
parents: 43
diff changeset
36 lock.locked = True
3024ded5ae61 Added functions for Lockable
KarstenBock@gmx.net
parents: 43
diff changeset
37
3024ded5ae61 Added functions for Lockable
KarstenBock@gmx.net
parents: 43
diff changeset
38 def unlock(lock):
3024ded5ae61 Added functions for Lockable
KarstenBock@gmx.net
parents: 43
diff changeset
39 lock.locked = False
3024ded5ae61 Added functions for Lockable
KarstenBock@gmx.net
parents: 43
diff changeset
40
3024ded5ae61 Added functions for Lockable
KarstenBock@gmx.net
parents: 43
diff changeset
41 def open(lock):
3024ded5ae61 Added functions for Lockable
KarstenBock@gmx.net
parents: 43
diff changeset
42 if lock.locked:
3024ded5ae61 Added functions for Lockable
KarstenBock@gmx.net
parents: 43
diff changeset
43 raise LockedError
3024ded5ae61 Added functions for Lockable
KarstenBock@gmx.net
parents: 43
diff changeset
44 lock.closed = False
3024ded5ae61 Added functions for Lockable
KarstenBock@gmx.net
parents: 43
diff changeset
45
3024ded5ae61 Added functions for Lockable
KarstenBock@gmx.net
parents: 43
diff changeset
46 def close(lock):
3024ded5ae61 Added functions for Lockable
KarstenBock@gmx.net
parents: 43
diff changeset
47 lock.closed = True