ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/Deliantra-Client/DC.pm
Revision: 1.121
Committed: Fri Sep 29 00:56:05 2006 UTC (17 years, 7 months ago) by root
Branch: MAIN
Changes since 1.120: +28 -15 lines
Log Message:
* implemented tip of the day window
* created some tips of the day, please add more
* rationalised errro report (and put client into debug mode :)
* add some random keyboard documentation

File Contents

# Content
1 =head1 NAME
2
3 CFPlus - undocumented utility garbage for our crossfire client
4
5 =head1 SYNOPSIS
6
7 use CFPlus;
8
9 =head1 DESCRIPTION
10
11 =over 4
12
13 =cut
14
15 package CFPlus;
16
17 use Carp ();
18
19 BEGIN {
20 $VERSION = '0.52';
21
22 use XSLoader;
23 XSLoader::load "CFPlus", $VERSION;
24 }
25
26 BEGIN {
27 $SIG{__DIE__} = sub {
28 return if CFPlus::in_destruct;
29 #CFPlus::fatal $_[0];#d#
30 CFPlus::error Carp::longmess $_[0];#d#
31 die;#d#
32 };
33 }
34
35 use utf8;
36
37 use AnyEvent ();
38 use BerkeleyDB;
39 use Pod::POM ();
40 use Scalar::Util ();
41 use Storable (); # finally
42
43 =item guard { BLOCK }
44
45 Returns an object that executes the given block as soon as it is destroyed.
46
47 =cut
48
49 sub guard(&) {
50 bless \(my $cb = $_[0]), "CFPlus::Guard"
51 }
52
53 sub CFPlus::Guard::DESTROY {
54 ${$_[0]}->()
55 }
56
57 sub asxml($) {
58 local $_ = $_[0];
59
60 s/&/&/g;
61 s/>/>/g;
62 s/</&lt;/g;
63
64 $_
65 }
66
67 package CFPlus::Database;
68
69 our @ISA = BerkeleyDB::Btree::;
70
71 sub get($$) {
72 my $data;
73
74 $_[0]->db_get ($_[1], $data) == 0
75 ? $data
76 : ()
77 }
78
79 my %DB_SYNC;
80
81 sub put($$$) {
82 my ($db, $key, $data) = @_;
83
84 my $hkey = $db + 0;
85 Scalar::Util::weaken $db;
86 $DB_SYNC{$hkey} ||= AnyEvent->timer (after => 5, cb => sub {
87 delete $DB_SYNC{$hkey};
88 $db->db_sync if $db;
89 });
90
91 $db->db_put ($key => $data)
92 }
93
94 package CFPlus;
95
96 sub find_rcfile($) {
97 my $path;
98
99 for (grep !ref, @INC) {
100 $path = "$_/CFPlus/resources/$_[0]";
101 return $path if -r $path;
102 }
103
104 die "FATAL: can't find required file $_[0]\n";
105 }
106
107 BEGIN {
108 use Crossfire::Protocol::Base ();
109 *to_json = \&Crossfire::Protocol::Base::to_json;
110 *from_json = \&Crossfire::Protocol::Base::from_json;
111 }
112
113 sub read_cfg {
114 my ($file) = @_;
115
116 open my $fh, $file
117 or return;
118
119 local $/;
120 my $CFG = <$fh>;
121
122 if ($CFG =~ /^---/) { ## TODO compatibility cruft, remove
123 require YAML;
124 utf8::decode $CFG;
125 $::CFG = YAML::Load ($CFG);
126 } elsif ($CFG =~ /^\{/) {
127 $::CFG = from_json $CFG;
128 } else {
129 $::CFG = eval $CFG; ## todo comaptibility cruft
130 }
131 }
132
133 sub write_cfg {
134 my ($file) = @_;
135
136 $::CFG->{VERSION} = $::VERSION;
137
138 open my $fh, ">:utf8", $file
139 or return;
140 print $fh to_json $::CFG;
141 }
142
143 our $DB_ENV;
144 our $DB_STATE;
145
146 sub db_table($) {
147 my ($table) = @_;
148
149 $table =~ s/([^a-zA-Z0-9_\-])/sprintf "=%x=", ord $1/ge;
150
151 new CFPlus::Database
152 -Env => $DB_ENV,
153 -Filename => $table,
154 # -Filename => "database",
155 # -Subname => $table,
156 -Property => DB_CHKSUM,
157 -Flags => DB_CREATE | DB_UPGRADE,
158 or die "unable to create/open database table $_[0]: $BerkeleyDB::Error"
159 }
160
161 {
162 use strict;
163
164 mkdir "$Crossfire::VARDIR/cfplus", 0777;
165 my $recover = $BerkeleyDB::db_version >= 4.4
166 ? eval "DB_REGISTER | DB_RECOVER"
167 : 0;
168
169 $DB_ENV = new BerkeleyDB::Env
170 -Home => "$Crossfire::VARDIR/cfplus",
171 -Cachesize => 1_000_000,
172 -ErrFile => "$Crossfire::VARDIR/cfplus/errorlog.txt",
173 # -ErrPrefix => "DATABASE",
174 -Verbose => 1,
175 -Flags => DB_CREATE | DB_RECOVER | DB_INIT_MPOOL | DB_INIT_LOCK | DB_INIT_TXN | $recover,
176 -SetFlags => DB_AUTO_COMMIT | DB_LOG_AUTOREMOVE,
177 or die "unable to create/open database home $Crossfire::VARDIR/cfplus: $BerkeleyDB::Error";
178
179 $DB_STATE = db_table "state";
180 }
181
182 package CFPlus::Layout;
183
184 $CFPlus::OpenGL::SHUTDOWN_HOOK{"CFPlus::Layout"} = sub {
185 reset_glyph_cache;
186 };
187
188 package CFPlus::Item;
189
190 use strict;
191 use Crossfire::Protocol::Constants;
192
193 my $last_enter_count = 1;
194
195 sub desc_string {
196 my ($self) = @_;
197
198 my $desc =
199 $self->{nrof} < 2
200 ? $self->{name}
201 : "$self->{nrof} × $self->{name_pl}";
202
203 $self->{flags} & F_OPEN
204 and $desc .= " (open)";
205 $self->{flags} & F_APPLIED
206 and $desc .= " (applied)";
207 $self->{flags} & F_UNPAID
208 and $desc .= " (unpaid)";
209 $self->{flags} & F_MAGIC
210 and $desc .= " (magic)";
211 $self->{flags} & F_CURSED
212 and $desc .= " (cursed)";
213 $self->{flags} & F_DAMNED
214 and $desc .= " (damned)";
215 $self->{flags} & F_LOCKED
216 and $desc .= " *";
217
218 $desc
219 }
220
221 sub weight_string {
222 my ($self) = @_;
223
224 my $weight = ($self->{nrof} || 1) * $self->{weight};
225
226 $weight < 0 ? "?" : $weight * 0.001
227 }
228
229 sub do_n_dialog {
230 my ($cb) = @_;
231
232 my $w = new CFPlus::UI::Toplevel
233 on_delete => sub { $_[0]->destroy; 1 },
234 has_close_button => 1,
235 ;
236
237 $w->add (my $vb = new CFPlus::UI::VBox x => "center", y => "center");
238 $vb->add (new CFPlus::UI::Label text => "Enter item count:");
239 $vb->add (my $entry = new CFPlus::UI::Entry
240 text => $last_enter_count,
241 on_activate => sub {
242 my ($entry) = @_;
243 $last_enter_count = $entry->get_text;
244 $cb->($last_enter_count);
245 $w->hide;
246 $w->destroy;
247
248 0
249 },
250 on_escape => sub { $w->destroy; 1 },
251 );
252 $entry->grab_focus;
253 $w->show;
254 }
255
256 sub update_widgets {
257 my ($self) = @_;
258
259 # necessary to avoid cyclic references
260 Scalar::Util::weaken $self;
261
262 my $button_cb = sub {
263 my (undef, $ev, $x, $y) = @_;
264
265 my $targ = $::CONN->{player}{tag};
266
267 if ($self->{container} == $::CONN->{player}{tag}) {
268 $targ = $::CONN->{open_container};
269 }
270
271 if (($ev->{mod} & CFPlus::KMOD_SHIFT) && $ev->{button} == 1) {
272 $::CONN->send ("move $targ $self->{tag} 0")
273 if $targ || !($self->{flags} & F_LOCKED);
274 } elsif (($ev->{mod} & CFPlus::KMOD_SHIFT) && $ev->{button} == 2) {
275 $self->{flags} & F_LOCKED
276 ? $::CONN->send ("lock " . pack "CN", 0, $self->{tag})
277 : $::CONN->send ("lock " . pack "CN", 1, $self->{tag})
278 } elsif ($ev->{button} == 1) {
279 $::CONN->send ("examine $self->{tag}");
280 } elsif ($ev->{button} == 2) {
281 $::CONN->send ("apply $self->{tag}");
282 } elsif ($ev->{button} == 3) {
283 my $move_prefix = $::CONN->{open_container} ? 'put' : 'drop';
284 if ($self->{container} == $::CONN->{open_container}) {
285 $move_prefix = "take";
286 }
287
288 my @menu_items = (
289 ["examine", sub { $::CONN->send ("examine $self->{tag}") }],
290 ["mark", sub { $::CONN->send ("mark ". pack "N", $self->{tag}) }],
291 ["ignite/thaw", # first try of an easier use of flint&steel
292 sub {
293 $::CONN->send ("mark ". pack "N", $self->{tag});
294 $::CONN->send ("command apply flint and steel");
295 }
296 ],
297 ["inscribe", # first try of an easier use of flint&steel
298 sub {
299 &::open_string_query ("Text to inscribe", sub {
300 my ($entry, $txt) = @_;
301 $::CONN->send ("mark ". pack "N", $self->{tag});
302 $::CONN->send ("command use_skill inscription $txt");
303 });
304 }
305 ],
306 ["rename", # first try of an easier use of flint&steel
307 sub {
308 &::open_string_query ("Rename item to:", sub {
309 my ($entry, $txt) = @_;
310 $::CONN->send ("mark ". pack "N", $self->{tag});
311 $::CONN->send ("command rename to <$txt>");
312 }, $self->{name},
313 "If you input no name or erase the current custom name, the custom name will be unset");
314 }
315 ],
316 ["apply", sub { $::CONN->send ("apply $self->{tag}") }],
317 (
318 $self->{flags} & F_LOCKED
319 ? (
320 ["unlock", sub { $::CONN->send ("lock " . pack "CN", 0, $self->{tag}) }],
321 )
322 : (
323 ["lock", sub { $::CONN->send ("lock " . pack "CN", 1, $self->{tag}) }],
324 ["$move_prefix all", sub { $::CONN->send ("move $targ $self->{tag} 0") }],
325 ["$move_prefix &lt;n&gt;",
326 sub {
327 do_n_dialog (sub { $::CONN->send ("move $targ $self->{tag} $_[0]") })
328 }
329 ]
330 )
331 ),
332 );
333
334 CFPlus::UI::Menu->new (items => \@menu_items)->popup ($ev);
335 }
336
337 1
338 };
339
340 my $tooltip_std = "<small>"
341 . "Left click - examine item\n"
342 . "Shift-Left click - " . ($self->{container} ? "move or drop" : "take") . " item\n"
343 . "Middle click - apply\n"
344 . "Shift-Middle click - lock/unlock\n"
345 . "Right click - further options"
346 . "</small>\n";
347
348 my $bg = $self->{flags} & F_CURSED ? [1 , 0 , 0, 0.5]
349 : $self->{flags} & F_MAGIC ? [0.2, 0.2, 1, 0.5]
350 : undef;
351
352 $self->{face_widget} ||= new CFPlus::UI::Face
353 can_events => 1,
354 can_hover => 1,
355 anim => $self->{anim},
356 animspeed => $self->{animspeed}, # TODO# must be set at creation time
357 on_button_down => $button_cb,
358 ;
359 $self->{face_widget}{bg} = $bg;
360 $self->{face_widget}{face} = $self->{face};
361 $self->{face_widget}{anim} = $self->{anim};
362 $self->{face_widget}{animspeed} = $self->{animspeed};
363 $self->{face_widget}->set_tooltip (
364 "<b>Face/Animation.</b>\n"
365 . "Item uses face #$self->{face}. "
366 . ($self->{animspeed} ? "Item uses animation #$self->{anim} at " . (1 / $self->{animspeed}) . "fps. " : "Item is not animated. ")
367 . "\n\n$tooltip_std"
368 );
369
370 $self->{desc_widget} ||= new CFPlus::UI::Label
371 can_events => 1,
372 can_hover => 1,
373 ellipsise => 2,
374 align => -1,
375 on_button_down => $button_cb,
376 ;
377 my $desc = CFPlus::Item::desc_string $self;
378 $self->{desc_widget}{bg} = $bg;
379 $self->{desc_widget}->set_text ($desc);
380 $self->{desc_widget}->set_tooltip ("<b>$desc</b>.\n$tooltip_std");
381
382 $self->{weight_widget} ||= new CFPlus::UI::Label
383 can_events => 1,
384 can_hover => 1,
385 ellipsise => 0,
386 align => 0,
387 on_button_down => $button_cb,
388 ;
389 $self->{weight_widget}{bg} = $bg;
390 $self->{weight_widget}->set_text (CFPlus::Item::weight_string $self);
391 $self->{weight_widget}->set_tooltip (
392 "<b>Weight</b>.\n"
393 . ($self->{weight} >= 0 ? "One item weighs $self->{weight}g. " : "You have no idea how much this weighs. ")
394 . ($self->{nrof} ? "You have $self->{nrof} of it. " : "Item cannot stack with others of it's kind. ")
395 . "\n\n$tooltip_std"
396 );
397 }
398
399 1;
400
401 =back
402
403 =head1 AUTHOR
404
405 Marc Lehmann <schmorp@schmorp.de>
406 http://home.schmorp.de/
407
408 =cut
409