1 |
=head1 NAME |
2 |
|
3 |
CFClient - undocumented utility garbage for our crossfire client |
4 |
|
5 |
=head1 SYNOPSIS |
6 |
|
7 |
use CFClient; |
8 |
|
9 |
=head1 DESCRIPTION |
10 |
|
11 |
=over 4 |
12 |
|
13 |
=cut |
14 |
|
15 |
package CFClient; |
16 |
|
17 |
BEGIN { |
18 |
$VERSION = '0.1'; |
19 |
|
20 |
use XSLoader; |
21 |
XSLoader::load "CFClient", $VERSION; |
22 |
} |
23 |
|
24 |
use utf8; |
25 |
|
26 |
use Carp (); |
27 |
use AnyEvent (); |
28 |
use BerkeleyDB; |
29 |
use Pod::POM; |
30 |
|
31 |
sub find_rcfile($) { |
32 |
my $path; |
33 |
|
34 |
for (grep !ref, @INC) { |
35 |
$path = "$_/CFClient/resources/$_[0]"; |
36 |
return $path if -r $path; |
37 |
} |
38 |
|
39 |
die "FATAL: can't find required file $_[0]\n"; |
40 |
} |
41 |
|
42 |
sub read_cfg { |
43 |
my ($file) = @_; |
44 |
|
45 |
open CFG, $file |
46 |
or return; |
47 |
|
48 |
my $CFG; |
49 |
|
50 |
local $/; |
51 |
$CFG = eval <CFG>; |
52 |
|
53 |
$::CFG = $CFG; |
54 |
|
55 |
close CFG; |
56 |
} |
57 |
|
58 |
sub write_cfg { |
59 |
my ($file) = @_; |
60 |
|
61 |
open CFG, ">$file" |
62 |
or return; |
63 |
|
64 |
{ |
65 |
require Data::Dumper; |
66 |
local $Data::Dumper::Purity = 1; |
67 |
$::CFG->{VERSION} = $::VERSION; |
68 |
print CFG Data::Dumper->Dump ([$::CFG], [qw/CFG/]); |
69 |
} |
70 |
|
71 |
close CFG; |
72 |
} |
73 |
|
74 |
my %POD_CACHE; |
75 |
|
76 |
sub load_pod($) { |
77 |
$POD_CACHE{$_[0]} ||= do { |
78 |
my $pod = do { |
79 |
local $/; |
80 |
open my $pod, "<:utf8", $_[0] |
81 |
or die "$_[0]: $!"; |
82 |
<$pod> |
83 |
}; |
84 |
|
85 |
Pod::POM->new->parse_text ($pod) |
86 |
} |
87 |
} |
88 |
|
89 |
our $DB_ENV; |
90 |
|
91 |
{ |
92 |
use strict; |
93 |
|
94 |
mkdir "$Crossfire::VARDIR/cfplus", 0777; |
95 |
my $recover = $BerkeleyDB::db_version >= 4.4 |
96 |
? eval "DB_REGISTER | DB_RECOVER" |
97 |
: 0; |
98 |
|
99 |
$DB_ENV = new BerkeleyDB::Env |
100 |
-Home => "$Crossfire::VARDIR/cfplus", |
101 |
-Cachesize => 1_000_000, |
102 |
-ErrFile => "$Crossfire::VARDIR/cfplus/errorlog.txt", |
103 |
# -ErrPrefix => "DATABASE", |
104 |
-Verbose => 1, |
105 |
-Flags => DB_CREATE | DB_RECOVER | DB_INIT_MPOOL | DB_INIT_LOCK | DB_INIT_TXN | $recover, |
106 |
-SetFlags => DB_AUTO_COMMIT | DB_LOG_AUTOREMOVE, |
107 |
or die "unable to create/open database home $Crossfire::VARDIR/cfplus: $BerkeleyDB::Error"; |
108 |
} |
109 |
|
110 |
sub db_table($) { |
111 |
my ($table) = @_; |
112 |
|
113 |
$table =~ s/([^a-zA-Z0-9_\-])/sprintf "=%x=", ord $1/ge; |
114 |
|
115 |
new CFClient::Database |
116 |
-Env => $DB_ENV, |
117 |
-Filename => $table, |
118 |
# -Filename => "database", |
119 |
# -Subname => $table, |
120 |
-Property => DB_CHKSUM, |
121 |
-Flags => DB_CREATE | DB_UPGRADE, |
122 |
or die "unable to create/open database table $_[0]: $BerkeleyDB::Error" |
123 |
} |
124 |
|
125 |
sub pod_to_pango($) { |
126 |
my ($pom) = @_; |
127 |
|
128 |
$pom->present ("CFClient::PodToPango") |
129 |
} |
130 |
|
131 |
sub pod_to_pango_list($) { |
132 |
my ($pom) = @_; |
133 |
|
134 |
[ |
135 |
map s/^(\s*)// && [40 * length $1, length $_ ? $_ : " "], |
136 |
split /\n/, $pom->present ("CFClient::PodToPango") |
137 |
] |
138 |
} |
139 |
|
140 |
package CFClient::PodToPango; |
141 |
|
142 |
use base Pod::POM::View::Text; |
143 |
|
144 |
our $indent = 0; |
145 |
|
146 |
*view_seq_code = |
147 |
*view_seq_bold = sub { "<b>$_[1]</b>" }; |
148 |
*view_seq_italic = sub { "<i>$_[1]</i>" }; |
149 |
*view_seq_space = |
150 |
*view_seq_link = |
151 |
*view_seq_index = sub { CFClient::UI::Label::escape ($_[1]) }; |
152 |
|
153 |
sub view_seq_text { |
154 |
my $text = $_[1]; |
155 |
$text =~ s/\s+/ /g; |
156 |
CFClient::UI::Label::escape ($text) |
157 |
} |
158 |
|
159 |
sub view_item { |
160 |
("\t" x ($indent / 4)) |
161 |
. $_[1]->title->present ($_[0]) |
162 |
. "\n" |
163 |
. $_[1]->content->present ($_[0]) |
164 |
} |
165 |
|
166 |
sub view_verbatim { |
167 |
(join "", |
168 |
map +("\t" x ($indent / 2)) . "<tt>$_</tt>\n", |
169 |
split /\n/, CFClient::UI::Label::escape ($_[1])) |
170 |
. "\n" |
171 |
} |
172 |
|
173 |
sub view_textblock { |
174 |
("\t" x ($indent / 2)) . "$_[1]\n\n" |
175 |
} |
176 |
|
177 |
sub view_head1 { |
178 |
"\n\n<span foreground='#ffff00' size='x-large'>" . $_[1]->title->present ($_[0]) . "</span>\n\n" |
179 |
. $_[1]->content->present ($_[0]) |
180 |
}; |
181 |
|
182 |
sub view_head2 { |
183 |
"\n<span foreground='#ccccff' size='large'>" . $_[1]->title->present ($_[0]) . "</span>\n\n" |
184 |
. $_[1]->content->present ($_[0]) |
185 |
}; |
186 |
|
187 |
sub view_head3 { |
188 |
"\n<span size='large'>" . $_[1]->title->present ($_[0]) . "</span>\n\n" |
189 |
. $_[1]->content->present ($_[0]) |
190 |
}; |
191 |
|
192 |
sub view_over { |
193 |
local $indent = $indent + $_[1]->indent; |
194 |
$_[1]->content->present ($_[0]) |
195 |
} |
196 |
|
197 |
package CFClient::Database; |
198 |
|
199 |
our @ISA = BerkeleyDB::Btree::; |
200 |
|
201 |
sub get($$) { |
202 |
my $data; |
203 |
|
204 |
$_[0]->db_get ($_[1], $data) == 0 |
205 |
? $data |
206 |
: () |
207 |
} |
208 |
|
209 |
my %DB_SYNC; |
210 |
|
211 |
sub put($$$) { |
212 |
my ($db, $key, $data) = @_; |
213 |
|
214 |
$DB_SYNC{$db} = AnyEvent->timer (after => 5, cb => sub { $db->db_sync }); |
215 |
|
216 |
$db->db_put ($key => $data) |
217 |
} |
218 |
|
219 |
package CFClient::Item; |
220 |
|
221 |
use strict; |
222 |
use Crossfire::Protocol::Constants; |
223 |
|
224 |
my $last_enter_count = 1; |
225 |
|
226 |
sub desc_string { |
227 |
my ($self) = @_; |
228 |
|
229 |
my $desc = |
230 |
$self->{nrof} < 2 |
231 |
? $self->{name} |
232 |
: "$self->{nrof} × $self->{name_pl}"; |
233 |
|
234 |
$self->{flags} & F_OPEN |
235 |
and $desc .= " (open)"; |
236 |
$self->{flags} & F_APPLIED |
237 |
and $desc .= " (applied)"; |
238 |
$self->{flags} & F_UNPAID |
239 |
and $desc .= " (unpaid)"; |
240 |
$self->{flags} & F_MAGIC |
241 |
and $desc .= " (magic)"; |
242 |
$self->{flags} & F_CURSED |
243 |
and $desc .= " (cursed)"; |
244 |
$self->{flags} & F_DAMNED |
245 |
and $desc .= " (damned)"; |
246 |
$self->{flags} & F_LOCKED |
247 |
and $desc .= " *"; |
248 |
|
249 |
$desc |
250 |
} |
251 |
|
252 |
sub weight_string { |
253 |
my ($self) = @_; |
254 |
|
255 |
my $weight = ($self->{nrof} || 1) * $self->{weight}; |
256 |
|
257 |
$weight < 0 ? "?" : $weight * 0.001 |
258 |
} |
259 |
|
260 |
sub do_n_dialog { |
261 |
my ($cb) = @_; |
262 |
|
263 |
my $w = new CFClient::UI::FancyFrame; |
264 |
$w->add (my $vb = new CFClient::UI::VBox x => "center", y => "center"); |
265 |
$vb->add (new CFClient::UI::Label text => "Enter item count:"); |
266 |
$vb->add (my $entry = new CFClient::UI::Entry |
267 |
text => $last_enter_count, |
268 |
on_activate => sub { |
269 |
my ($entry) = @_; |
270 |
$last_enter_count = $entry->get_text; |
271 |
$cb->($last_enter_count); |
272 |
$w->hide; |
273 |
$w = undef; |
274 |
} |
275 |
); |
276 |
$entry->focus_in; |
277 |
$w->show; |
278 |
|
279 |
} |
280 |
|
281 |
sub update_widgets { |
282 |
my ($self) = @_; |
283 |
|
284 |
my $button_cb = sub { |
285 |
my (undef, $ev, $x, $y) = @_; |
286 |
|
287 |
my $targ = $::CONN->{player}{tag}; |
288 |
|
289 |
if ($self->{container} == $::CONN->{player}{tag}) { |
290 |
$targ = $::CONN->{open_container}; |
291 |
} |
292 |
|
293 |
if (($ev->{mod} & CFClient::KMOD_SHIFT) && $ev->{button} == 1) { |
294 |
$::CONN->send ("move $targ $self->{tag} 0") |
295 |
if $targ || !($self->{flags} & F_LOCKED); |
296 |
} elsif (($ev->{mod} & CFClient::KMOD_SHIFT) && $ev->{button} == 2) { |
297 |
$self->{flags} & F_LOCKED |
298 |
? $::CONN->send ("lock " . pack "CN", 0, $self->{tag}) |
299 |
: $::CONN->send ("lock " . pack "CN", 1, $self->{tag}) |
300 |
} elsif ($ev->{button} == 1) { |
301 |
$::CONN->send ("examine $self->{tag}"); |
302 |
} elsif ($ev->{button} == 2) { |
303 |
$::CONN->send ("apply $self->{tag}"); |
304 |
} elsif ($ev->{button} == 3) { |
305 |
my @menu_items = ( |
306 |
["examine", sub { $::CONN->send ("examine $self->{tag}") }], |
307 |
["mark", sub { $::CONN->send ("mark ". pack "N", $self->{tag}) }], |
308 |
["apply", sub { $::CONN->send ("apply $self->{tag}") }], |
309 |
( |
310 |
$self->{flags} & F_LOCKED |
311 |
? ( |
312 |
["unlock", sub { $::CONN->send ("lock " . pack "CN", 0, $self->{tag}) }], |
313 |
) |
314 |
: ( |
315 |
["lock", sub { $::CONN->send ("lock " . pack "CN", 1, $self->{tag}) }], |
316 |
["drop", sub { $::CONN->send ("move $::CONN->{open_container} $self->{tag} 0") }], |
317 |
["move n", |
318 |
sub { |
319 |
do_n_dialog (sub { $::CONN->send ("move $targ $self->{tag} $_[0]") }) |
320 |
} |
321 |
] |
322 |
) |
323 |
), |
324 |
); |
325 |
|
326 |
CFClient::UI::Menu->new (items => \@menu_items)->popup ($ev); |
327 |
} |
328 |
|
329 |
1 |
330 |
}; |
331 |
|
332 |
my $tooltip_std = "<small>" |
333 |
. "Left click - examine item\n" |
334 |
. "Shift-Left click - " . ($self->{container} ? "move or drop" : "take") . " item\n" |
335 |
. "Middle click - apply\n" |
336 |
. "Shift-Middle click - lock/unlock\n" |
337 |
. "Right click - further options" |
338 |
. "</small>\n"; |
339 |
|
340 |
$self->{face_widget} ||= new CFClient::UI::Face |
341 |
can_events => 1, |
342 |
can_hover => 1, |
343 |
anim => $self->{anim}, |
344 |
animspeed => $self->{animspeed}, # TODO# must be set at creation time |
345 |
on_button_down => $button_cb, |
346 |
; |
347 |
$self->{face_widget}{face} = $self->{face}; |
348 |
$self->{face_widget}{anim} = $self->{anim}; |
349 |
$self->{face_widget}{animspeed} = $self->{animspeed}; |
350 |
$self->{face_widget}->set_tooltip ( |
351 |
"<b>Face/Animation.</b>\n" |
352 |
. "Item uses face #$self->{face}. " |
353 |
. ($self->{animspeed} ? "Item uses animation #$self->{anim} at " . (1 / $self->{animspeed}) . "fps. " : "Item is not animated. ") |
354 |
. "\n\n$tooltip_std" |
355 |
); |
356 |
|
357 |
$self->{desc_widget} ||= new CFClient::UI::Label |
358 |
can_events => 1, |
359 |
can_hover => 1, |
360 |
ellipsise => 2, |
361 |
align => -1, |
362 |
on_button_down => $button_cb, |
363 |
; |
364 |
my $desc = CFClient::Item::desc_string $self; |
365 |
$self->{desc_widget}->set_text ($desc); |
366 |
$self->{desc_widget}->set_tooltip ("<b>$desc</b>.\n$tooltip_std"); |
367 |
|
368 |
$self->{weight_widget} ||= new CFClient::UI::Label |
369 |
can_events => 1, |
370 |
can_hover => 1, |
371 |
ellipsise => 0, |
372 |
align => 0, |
373 |
on_button_down => $button_cb, |
374 |
; |
375 |
$self->{weight_widget}->set_text (CFClient::Item::weight_string $self); |
376 |
|
377 |
$self->{weight_widget}->set_tooltip ( |
378 |
"<b>Weight</b>.\n" |
379 |
. ($self->{weight} >= 0 ? "One item weighs $self->{weight}g. " : "You have no idea how much this weighs. ") |
380 |
. ($self->{nrof} ? "You have $self->{nrof} of it. " : "Item cannot stack with others of it's kind. ") |
381 |
. "\n\n$tooltip_std" |
382 |
); |
383 |
} |
384 |
|
385 |
package CFClient::Binder; |
386 |
|
387 |
my @ALLOWED_MODIFIER_KEYS = ( |
388 |
CFClient::SDLK_LSHIFT, |
389 |
CFClient::SDLK_LCTRL , |
390 |
CFClient::SDLK_LALT , |
391 |
CFClient::SDLK_LMETA , |
392 |
|
393 |
CFClient::SDLK_RSHIFT, |
394 |
CFClient::SDLK_RCTRL , |
395 |
CFClient::SDLK_RALT , |
396 |
CFClient::SDLK_RMETA , |
397 |
); |
398 |
|
399 |
my %ALLOWED_MODIFIERS = ( |
400 |
CFClient::KMOD_LSHIFT => "LSHIFT", |
401 |
CFClient::KMOD_LCTRL => "LCTRL", |
402 |
CFClient::KMOD_LALT => "LALT", |
403 |
CFClient::KMOD_LMETA => "LMETA", |
404 |
|
405 |
CFClient::KMOD_RSHIFT => "RSHIFT", |
406 |
CFClient::KMOD_RCTRL => "RCTRL", |
407 |
CFClient::KMOD_RALT => "RALT", |
408 |
CFClient::KMOD_RMETA => "RMETA", |
409 |
); |
410 |
|
411 |
my %DIRECT_BIND_CHARS = map { $_ => 1 } qw/0 1 2 3 4 5 6 7 8 9/; |
412 |
my @DIRECT_BIND_KEYS = ( |
413 |
CFClient::SDLK_F1, |
414 |
CFClient::SDLK_F2, |
415 |
CFClient::SDLK_F3, |
416 |
CFClient::SDLK_F4, |
417 |
CFClient::SDLK_F5, |
418 |
CFClient::SDLK_F6, |
419 |
CFClient::SDLK_F7, |
420 |
CFClient::SDLK_F8, |
421 |
CFClient::SDLK_F9, |
422 |
CFClient::SDLK_F10, |
423 |
CFClient::SDLK_F11, |
424 |
CFClient::SDLK_F12, |
425 |
CFClient::SDLK_F13, |
426 |
CFClient::SDLK_F14, |
427 |
CFClient::SDLK_F15, |
428 |
); |
429 |
|
430 |
# this binding dialog asks for a key-combo to be pressed |
431 |
# and if successful it calls the $cb with $mod and $sym as args. |
432 |
sub open_binding_dialog { |
433 |
my ($cb) = @_; |
434 |
|
435 |
my $w = new CFClient::UI::FancyFrame |
436 |
title => "Bind Action", |
437 |
x => "center", |
438 |
y => "center"; |
439 |
|
440 |
$w->add (my $vb = new CFClient::UI::VBox); |
441 |
$vb->add (new CFClient::UI::Label |
442 |
text => "Press a modifier (CTRL, ALT and/or SHIFT) and a key." |
443 |
."You can only bind 0-9 and F1-F15 without modifiers." |
444 |
); |
445 |
$vb->add (my $entry = new CFClient::UI::Entry |
446 |
text => "", |
447 |
on_key_down => sub { |
448 |
my ($entry, $ev) = @_; |
449 |
|
450 |
my $mod = $ev->{mod}; |
451 |
my $sym = $ev->{sym}; |
452 |
|
453 |
# XXX: This seems a little bit hackisch to me, but i have to ignore them |
454 |
if (grep { $_ == $sym } @ALLOWED_MODIFIER_KEYS) { |
455 |
return; |
456 |
} |
457 |
|
458 |
if ($mod == CFClient::KMOD_NONE |
459 |
and not $DIRECT_BIND_CHARS{chr ($ev->{unicode})} |
460 |
and not grep { $sym == $_ } @DIRECT_BIND_KEYS) |
461 |
{ |
462 |
$::STATUSBOX->add ( |
463 |
"Can't bind key ".CFClient::SDL_GetKeyName ($sym) |
464 |
." directly without modifier! It would damage the completer handling." |
465 |
); |
466 |
return; |
467 |
} |
468 |
|
469 |
$entry->focus_out; |
470 |
|
471 |
$cb->($mod, $sym); |
472 |
|
473 |
$w->destroy |
474 |
}); |
475 |
|
476 |
$entry->focus_in; |
477 |
$w->show; |
478 |
} |
479 |
|
480 |
sub keycombo_to_name { |
481 |
my ($mod, $sym) = @_; |
482 |
|
483 |
my $mods = join '+', |
484 |
map { $ALLOWED_MODIFIERS{$_} } |
485 |
grep { ($_ + 0) & ($mod + 0) } |
486 |
keys %ALLOWED_MODIFIERS; |
487 |
$mods .= "+" if $mods ne ''; |
488 |
|
489 |
return $mods . CFClient::SDL_GetKeyName ($sym); |
490 |
} |
491 |
|
492 |
package CFClient::Pickup; |
493 |
# some pickup constants |
494 |
sub PU_NOTHING { 0x00000000 } |
495 |
|
496 |
sub PU_DEBUG { 0x10000000 } |
497 |
sub PU_INHIBIT { 0x20000000 } |
498 |
sub PU_STOP { 0x40000000 } |
499 |
sub PU_NEWMODE { 0x80000000 } |
500 |
|
501 |
sub PU_RATIO { 0x0000000F } |
502 |
|
503 |
sub PU_FOOD { 0x00000010 } |
504 |
sub PU_DRINK { 0x00000020 } |
505 |
sub PU_VALUABLES { 0x00000040 } |
506 |
sub PU_BOW { 0x00000080 } |
507 |
|
508 |
sub PU_ARROW { 0x00000100 } |
509 |
sub PU_HELMET { 0x00000200 } |
510 |
sub PU_SHIELD { 0x00000400 } |
511 |
sub PU_ARMOUR { 0x00000800 } |
512 |
|
513 |
sub PU_BOOTS { 0x00001000 } |
514 |
sub PU_GLOVES { 0x00002000 } |
515 |
sub PU_CLOAK { 0x00004000 } |
516 |
sub PU_KEY { 0x00008000 } |
517 |
|
518 |
sub PU_MISSILEWEAPON { 0x00010000 } |
519 |
sub PU_ALLWEAPON { 0x00020000 } |
520 |
sub PU_MAGICAL { 0x00040000 } |
521 |
sub PU_POTION { 0x00080000 } |
522 |
|
523 |
sub PU_SPELLBOOK { 0x00100000 } |
524 |
sub PU_SKILLSCROLL { 0x00200000 } |
525 |
sub PU_READABLES { 0x00400000 } |
526 |
sub PU_MAGIC_DEVICE { 0x00800000 } |
527 |
|
528 |
sub PU_NOT_CURSED { 0x01000000 } |
529 |
|
530 |
sub PU_JEWELS { 0x02000000 } |
531 |
|
532 |
|
533 |
1; |
534 |
|
535 |
=back |
536 |
|
537 |
=head1 AUTHOR |
538 |
|
539 |
Marc Lehmann <schmorp@schmorp.de> |
540 |
http://home.schmorp.de/ |
541 |
|
542 |
=cut |
543 |
|