ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/Deliantra-Client/DC.pm
Revision: 1.69
Committed: Thu May 25 23:06:05 2006 UTC (17 years, 11 months ago) by root
Branch: MAIN
Changes since 1.68: +8 -3 lines
Log Message:
greatly enhanced skills documentation, enhanced documentatino rendering

File Contents

# User Rev Content
1 root 1.1 =head1 NAME
2    
3 root 1.22 CFClient - undocumented utility garbage for our crossfire client
4 root 1.1
5     =head1 SYNOPSIS
6    
7 root 1.22 use CFClient;
8 root 1.1
9     =head1 DESCRIPTION
10    
11     =over 4
12    
13     =cut
14    
15 root 1.22 package CFClient;
16 root 1.1
17     BEGIN {
18     $VERSION = '0.1';
19    
20 root 1.2 use XSLoader;
21 root 1.22 XSLoader::load "CFClient", $VERSION;
22 root 1.1 }
23    
24 root 1.62 use utf8;
25    
26 root 1.43 use Carp ();
27 root 1.52 use AnyEvent ();
28 root 1.34 use BerkeleyDB;
29 root 1.52
30 root 1.41 use CFClient::OpenGL;
31 root 1.26
32 root 1.19 our %GL_EXT;
33     our $GL_VERSION;
34    
35     our $GL_NPOT;
36 root 1.49 our $GL_DEBUG = 1;
37 root 1.19
38     sub gl_init {
39     $GL_VERSION = gl_version * 1;
40     %GL_EXT = map +($_ => 1), split /\s+/, gl_extensions;
41    
42     $GL_NPOT = $GL_EXT{GL_ARB_texture_non_power_of_two} || $GL_VERSION >= 2;
43 elmex 1.59 $GL_NPOT = 0 if gl_vendor =~ /ATI Technologies/; # ATI doesn't get it right...
44 root 1.19
45 root 1.49 glDisable GL_COLOR_MATERIAL;
46 root 1.26 glShadeModel GL_FLAT;
47 root 1.49 glDisable GL_DITHER;
48 root 1.26 glDisable GL_DEPTH_TEST;
49 root 1.57 glDepthMask 0;
50 root 1.26 glHint GL_PERSPECTIVE_CORRECTION_HINT, GL_FASTEST;
51    
52 root 1.22 CFClient::Texture::restore_state ();
53 root 1.19 }
54    
55 root 1.49 sub gl_check {
56     return unless $GL_DEBUG;
57    
58     if (my $error = glGetError) {
59 root 1.61 my ($format, @args) = @_;
60     Carp::cluck sprintf "opengl error %x while $format", $error, @args;
61 root 1.49 }
62     }
63    
64 root 1.5 sub find_rcfile($) {
65     my $path;
66    
67 root 1.46 for (grep !ref, @INC) {
68 root 1.22 $path = "$_/CFClient/resources/$_[0]";
69 root 1.5 return $path if -r $path;
70     }
71    
72     die "FATAL: can't find required file $_[0]\n";
73     }
74    
75     sub read_cfg {
76     my ($file) = @_;
77    
78     open CFG, $file
79     or return;
80    
81     my $CFG;
82    
83     local $/;
84     $CFG = eval <CFG>;
85    
86     $::CFG = $CFG;
87    
88     close CFG;
89     }
90    
91     sub write_cfg {
92     my ($file) = @_;
93    
94     open CFG, ">$file"
95     or return;
96    
97     {
98 elmex 1.9 require Data::Dumper;
99 root 1.5 local $Data::Dumper::Purity = 1;
100     $::CFG->{VERSION} = $::VERSION;
101     print CFG Data::Dumper->Dump ([$::CFG], [qw/CFG/]);
102     }
103    
104     close CFG;
105     }
106    
107 root 1.34 mkdir "$Crossfire::VARDIR/pclient", 0777;
108    
109     our $DB_ENV = new BerkeleyDB::Env
110     -Home => "$Crossfire::VARDIR/pclient",
111     -Cachesize => 1_000_000,
112 root 1.39 -ErrFile => "$Crossfire::VARDIR/pclient/errorlog.txt",
113     # -ErrPrefix => "DATABASE",
114 root 1.34 -Verbose => 1,
115 root 1.58 -Flags => DB_CREATE | DB_RECOVER | DB_INIT_MPOOL | DB_INIT_LOCK | DB_INIT_TXN,
116 root 1.34 or die "unable to create/open database home $Crossfire::VARDIR/pclient: $BerkeleyDB::Error";
117    
118     sub db_table($) {
119 root 1.38 my ($table) = @_;
120    
121     $table =~ s/([^a-zA-Z0-9_\-])/sprintf "=%x=", ord $1/ge;
122    
123 root 1.34 new CFClient::Database
124     -Env => $DB_ENV,
125 root 1.38 -Filename => $table,
126     # -Filename => "database",
127     # -Subname => $table,
128 root 1.51 -Property => DB_CHKSUM,
129 root 1.34 -Flags => DB_CREATE | DB_UPGRADE,
130     or die "unable to create/open database table $_[0]: $BerkeleyDB::Error";
131     }
132    
133 root 1.52 sub pod_to_pango($) {
134     my ($pom) = @_;
135    
136     $pom->present ("CFClient::PodToPango")
137     }
138    
139 root 1.60 sub pod_to_pango_list($) {
140     my ($pom) = @_;
141    
142     [
143     map s/^(\s*)// && [40 * length $1, length $_ ? $_ : " "],
144     split /\n/, $pom->present ("CFClient::PodToPango")
145     ]
146     }
147    
148 root 1.52 package CFClient::PodToPango;
149    
150     use base Pod::POM::View::Text;
151    
152     our $indent = 0;
153    
154     *view_seq_code =
155     *view_seq_bold = sub { "<b>$_[1]</b>" };
156     *view_seq_italic = sub { "<i>$_[1]</i>" };
157     *view_seq_space =
158     *view_seq_link =
159     *view_seq_index = sub { CFClient::UI::Label::escape ($_[1]) };
160    
161     sub view_seq_text {
162     my $text = $_[1];
163     $text =~ s/\s+/ /g;
164     CFClient::UI::Label::escape ($text)
165     }
166    
167     sub view_item {
168     ("\t" x ($indent / 4))
169     . $_[1]->title->present ($_[0])
170     . "\n"
171     . $_[1]->content->present ($_[0])
172     }
173    
174 root 1.53 sub view_verbatim {
175     (join "",
176 root 1.69 map +("\t" x ($indent / 2)) . "<tt>$_</tt>\n",
177 root 1.53 split /\n/, CFClient::UI::Label::escape ($_[1]))
178     . "\n"
179     }
180    
181 root 1.52 sub view_textblock {
182     ("\t" x ($indent / 2)) . "$_[1]\n\n"
183     }
184    
185 root 1.60 sub view_head1 {
186 root 1.69 "\n\n<span foreground='#ffff00' size='x-large'>" . $_[1]->title->present ($_[0]) . "</span>\n\n"
187 root 1.60 . $_[1]->content->present ($_[0])
188     };
189    
190 root 1.52 sub view_head2 {
191 root 1.69 "\n<span foreground='#ccccff' size='large'>" . $_[1]->title->present ($_[0]) . "</span>\n\n"
192     . $_[1]->content->present ($_[0])
193     };
194    
195     sub view_head3 {
196     "\n<span size='large'>" . $_[1]->title->present ($_[0]) . "</span>\n\n"
197 root 1.52 . $_[1]->content->present ($_[0])
198     };
199    
200     sub view_over {
201     local $indent = $indent + $_[1]->indent;
202     $_[1]->content->present ($_[0])
203     }
204    
205 root 1.34 package CFClient::Database;
206    
207     our @ISA = BerkeleyDB::Btree::;
208    
209     sub get($$) {
210     my $data;
211    
212     $_[0]->db_get ($_[1], $data) == 0
213     ? $data
214 root 1.37 : ()
215 root 1.34 }
216    
217     my %DB_SYNC;
218    
219     sub put($$$) {
220     my ($db, $key, $data) = @_;
221    
222 root 1.37 $DB_SYNC{$db} = AnyEvent->timer (after => 5, cb => sub { $db->db_sync });
223 root 1.34
224 root 1.37 $db->db_put ($key => $data)
225 root 1.34 }
226    
227 root 1.62 package CFClient::Item;
228    
229     sub desc_string {
230     my ($self) = @_;
231    
232     my $desc =
233     $self->{nrof} < 2
234     ? $self->{name}
235     : "$self->{nrof} × $self->{name_pl}";
236    
237     $self->{flags} & Crossfire::Protocol::F_OPEN
238     and $desc .= " (open)";
239     $self->{flags} & Crossfire::Protocol::F_APPLIED
240     and $desc .= " (applied)";
241     $self->{flags} & Crossfire::Protocol::F_UNPAID
242     and $desc .= " (unpaid)";
243     $self->{flags} & Crossfire::Protocol::F_MAGIC
244     and $desc .= " (magic)";
245     $self->{flags} & Crossfire::Protocol::F_CURSED
246     and $desc .= " (cursed)";
247     $self->{flags} & Crossfire::Protocol::F_DAMNED
248     and $desc .= " (damned)";
249     $self->{flags} & Crossfire::Protocol::F_LOCKED
250     and $desc .= " *";
251    
252     $desc
253     }
254    
255     sub weight_string {
256     my ($self) = @_;
257    
258     my $weight = ($self->{nrof} || 1) * $self->{weight};
259    
260     $weight < 0 ? "?" : $weight * 0.001
261     }
262    
263     sub update_widgets {
264     my ($self) = @_;
265    
266 root 1.63 my $button_cb = sub {
267     my (undef, $ev, $x, $y) = @_;
268    
269     if (($ev->{mod} & CFClient::KMOD_SHIFT) && $ev->{button} == 1) {
270     my $targ = $::CONN->{player}{tag};
271    
272     if ($self->{container} == $::CONN->{player}{tag}) {
273 elmex 1.64 $targ = $::CONN->{open_container};
274 root 1.63 }
275    
276     $::CONN->send ("move $targ $self->{tag} 0");
277     } elsif ($ev->{button} == 1) {
278     $::CONN->send ("examine $self->{tag}");
279     } elsif ($ev->{button} == 2) {
280     $::CONN->send ("apply $self->{tag}");
281     } elsif ($ev->{button} == 3) {
282     my @menu_items = (
283     ["examine", sub { $::CONN->send ("examine $self->{tag}") }],
284     ["mark", sub { $::CONN->send ("mark ". pack "N", $self->{tag}) }],
285     ["apply", sub { $::CONN->send ("apply $self->{tag}") }],
286     (
287     $self->{flags} & Crossfire::Protocol::F_LOCKED
288     ? (
289     ["unlock", sub { $::CONN->send ("lock " . pack "CN", 0, $self->{tag}) }],
290     )
291     : (
292     ["lock", sub { $::CONN->send ("lock " . pack "CN", 1, $self->{tag}) }],
293 elmex 1.64 ["drop", sub { $::CONN->send ("move $::CONN->{open_container} $self->{tag} 0") }],
294 root 1.63 )
295     ),
296     );
297    
298     CFClient::UI::Menu->new (items => \@menu_items)->popup ($ev);
299     }
300    
301     1
302     };
303    
304 root 1.62 my $tooltip_std = "<small>"
305     . "Left click - examine item\n"
306     . "Shift-Left click - " . ($self->{container} ? "move or drop" : "take") . " item\n"
307     . "Middle click - apply\n"
308     . "Right click - further options"
309     . "</small>\n";
310    
311 root 1.63 $self->{face_widget} ||= new CFClient::UI::Face
312     can_events => 1,
313     can_hover => 1,
314 root 1.67 anim => $self->{anim},
315 root 1.66 animspeed => $self->{animspeed}, # TODO# must be set at creation time
316 root 1.63 connect_button_down => $button_cb,
317     ;
318 root 1.62 $self->{face_widget}{face} = $self->{face};
319     $self->{face_widget}{anim} = $self->{anim};
320 root 1.65 $self->{face_widget}{animspeed} = $self->{animspeed};
321 root 1.62 $self->{face_widget}->set_tooltip (
322     "<b>Face/Animation.</b>\n"
323     . "Item uses face #$self->{face}. "
324     . ($self->{animspeed} ? "Item uses animation #$self->{anim} at " . (1 / $self->{animspeed}) . "fps. " : "Item is not animated. ")
325     . "\n\n$tooltip_std"
326     );
327    
328 root 1.63 $self->{desc_widget} ||= new CFClient::UI::Label
329     can_events => 1,
330     can_hover => 1,
331     ellipsise => 2,
332 root 1.68 align => -1,
333 root 1.63 connect_button_down => $button_cb,
334     ;
335     my $desc = CFClient::Item::desc_string $self;
336     $self->{desc_widget}->set_text ($desc);
337     $self->{desc_widget}->set_tooltip ("<b>$desc</b>.\n$tooltip_std");
338    
339     $self->{weight_widget} ||= new CFClient::UI::Label
340     can_events => 1,
341     can_hover => 1,
342     ellipsise => 0,
343 root 1.68 align => 0,
344 root 1.63 connect_button_down => $button_cb,
345     ;
346 root 1.62 $self->{weight_widget}->set_text (CFClient::Item::weight_string $self);
347    
348     $self->{weight_widget}->set_tooltip (
349     "<b>Weight</b>.\n"
350     . ($self->{weight} >= 0 ? "One item weighs $self->{weight}g. " : "You have no idea how much this weighs. ")
351     . ($self->{nrof} ? "You have $self->{nrof} of it. " : "Item cannot stack with others of it's kind. ")
352     . "\n\n$tooltip_std"
353     );
354     }
355    
356 root 1.22 package CFClient::Texture;
357 root 1.3
358 root 1.25 use strict;
359    
360 root 1.3 use Scalar::Util;
361    
362 root 1.41 use CFClient::OpenGL;
363 root 1.3
364 root 1.35 my %TEXTURES;
365 root 1.3
366 root 1.14 sub new {
367 root 1.4 my ($class, %data) = @_;
368    
369 root 1.14 my $self = bless {
370 root 1.15 internalformat => GL_RGBA,
371     format => GL_RGBA,
372 root 1.29 type => GL_UNSIGNED_BYTE,
373 root 1.14 %data,
374     }, $class;
375 root 1.4
376 root 1.35 Scalar::Util::weaken ($TEXTURES{$self+0} = $self);
377 root 1.4
378     $self->upload;
379    
380     $self
381     }
382    
383     sub new_from_image {
384 root 1.33 my ($class, $image, %arg) = @_;
385 root 1.4
386 root 1.33 $class->new (image => $image, %arg)
387 root 1.4 }
388    
389 root 1.3 sub new_from_file {
390 root 1.42 my ($class, $path, %arg) = @_;
391 root 1.3
392     open my $fh, "<:raw", $path
393     or die "$path: $!";
394    
395     local $/;
396 root 1.42 $class->new_from_image (<$fh>, %arg)
397 root 1.3 }
398    
399 root 1.14 #sub new_from_surface {
400     # my ($class, $surface) = @_;
401     #
402     # $surface->rgba;
403     #
404     # $class->new (
405     # data => $surface->pixels,
406 root 1.24 # w => $surface->width,
407     # h => $surface->height,
408 root 1.14 # )
409     #}
410    
411 root 1.21 sub new_from_layout {
412 root 1.42 my ($class, $layout, %arg) = @_;
413 root 1.14
414 root 1.50 my ($w, $h, $data, $format, $internalformat) = $layout->render;
415 root 1.14
416     $class->new (
417 root 1.24 w => $w,
418     h => $h,
419 root 1.14 data => $data,
420 root 1.50 format => $format,
421     internalformat => $format,
422 root 1.29 type => GL_UNSIGNED_BYTE,
423 root 1.42 %arg,
424 root 1.4 )
425 root 1.3 }
426    
427 root 1.8 sub new_from_opengl {
428     my ($class, $w, $h, $cb) = @_;
429    
430 root 1.48 $class->new (w => $w || 1, h => $h || 1, render_cb => $cb)
431 root 1.8 }
432    
433 root 1.19 sub topot {
434     (grep $_ >= $_[0], 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768)[0]
435     }
436    
437 root 1.3 sub upload {
438     my ($self) = @_;
439    
440 root 1.27 return unless $GL_VERSION;
441 root 1.3
442 root 1.6 my $data;
443 root 1.3
444     if (exists $self->{data}) {
445 root 1.6 $data = $self->{data};
446 root 1.25
447 root 1.24 } elsif (exists $self->{render_cb}) {
448     glViewport 0, 0, $self->{w}, $self->{h};
449 root 1.12 glMatrixMode GL_PROJECTION;
450     glLoadIdentity;
451 root 1.31 glOrtho 0, $self->{w}, 0, $self->{h}, -10000, 10000;
452 root 1.12 glMatrixMode GL_MODELVIEW;
453     glLoadIdentity;
454 root 1.25 $self->{render_cb}->($self, $self->{w}, $self->{h});
455 root 1.8
456 root 1.3 } else {
457 root 1.29 ($self->{w}, $self->{h}, $data, $self->{internalformat}, $self->{format}, $self->{type})
458     = CFClient::load_image_inline $self->{image};
459 root 1.3 }
460    
461 root 1.24 my ($tw, $th) = @$self{qw(w h)};
462 root 1.19
463 root 1.47 unless ($tw > 0 && $th > 0) {
464 root 1.24 $tw = $th = 1;
465     $data = "\x00" x 64;
466     }
467    
468 root 1.32 $self->{minified} = [CFClient::average $tw, $th, $data]
469 root 1.33 if $self->{minify};
470 root 1.32
471 root 1.24 unless ($GL_NPOT) {
472     # TODO: does not work for zero-sized textures
473 root 1.19 $tw = topot $tw;
474     $th = topot $th;
475    
476 root 1.43 if (($tw != $self->{w} || $th != $self->{h}) && defined $data) {
477 root 1.24 my $bpp = (length $data) / ($self->{w} * $self->{h});
478 root 1.20 $data = pack "(a" . ($tw * $bpp) . ")*",
479 root 1.24 unpack "(a" . ($self->{w} * $bpp) . ")*", $data;
480     $data .= ("\x00" x ($tw * $bpp)) x ($th - $self->{h});
481 root 1.19 }
482     }
483    
484 root 1.24 $self->{s} = $self->{w} / $tw;
485     $self->{t} = $self->{h} / $th;
486 root 1.19
487 root 1.41 $self->{name} ||= glGenTexture;
488 root 1.3
489     glBindTexture GL_TEXTURE_2D, $self->{name};
490    
491     glTexParameter GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP;
492     glTexParameter GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP;
493 root 1.42
494     if ($::FAST) {
495     glTexParameter GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST;
496     glTexParameter GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST;
497 root 1.45 } elsif ($self->{mipmap} && $GL_VERSION >= 1.4) {
498     # alternatively check for 0x8191
499     glTexParameter GL_TEXTURE_2D, GL_GENERATE_MIPMAP, 1;
500     glTexParameter GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR;
501     glTexParameter GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR_MIPMAP_LINEAR;
502 root 1.42 } else {
503     glTexParameter GL_TEXTURE_2D, GL_GENERATE_MIPMAP, $self->{mipmap};
504     glTexParameter GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR;
505 root 1.45 glTexParameter GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR;
506 root 1.42 }
507 root 1.3
508 root 1.45 glGetError;
509    
510 root 1.8 if (defined $data) {
511     glTexImage2D GL_TEXTURE_2D, 0,
512 root 1.15 $self->{internalformat},
513 root 1.54 $tw, $th,
514 root 1.8 0,
515 root 1.14 $self->{format},
516 root 1.29 $self->{type},
517 root 1.8 $data;
518 root 1.49 CFClient::gl_check "uploading texture %dx%d if=%x f=%x t=%x",
519     $tw, $th, $self->{internalformat}, $self->{format}, $self->{type};
520 root 1.8 } else {
521     glCopyTexImage2D GL_TEXTURE_2D, 0,
522 root 1.15 $self->{internalformat},
523 root 1.8 0, 0,
524 root 1.19 $tw, $th,
525 root 1.8 0;
526 root 1.49 CFClient::gl_check "copying to texture %dx%d if=%x",
527     $tw, $th, $self->{internalformat};
528 root 1.8 }
529 root 1.55
530     glBindTexture GL_TEXTURE_2D, 0; # just to be on the safe side
531 root 1.3 }
532    
533     sub DESTROY {
534     my ($self) = @_;
535    
536 root 1.35 delete $TEXTURES{$self+0};
537    
538 root 1.41 glDeleteTexture delete $self->{name}
539 root 1.36 if $self->{name};
540 root 1.3 }
541    
542 root 1.54 sub restore_state {
543 root 1.3 $_->upload
544 root 1.36 for values %TEXTURES;
545 root 1.54 }
546 root 1.3
547 root 1.1 1;
548    
549     =back
550    
551     =head1 AUTHOR
552    
553     Marc Lehmann <schmorp@schmorp.de>
554     http://home.schmorp.de/
555    
556     =cut
557