make_methodp - Dalam Talian di Awan

JADUAL:

NAMA

make_method - Tukar kod Perl menjadi penerangan XML untuk RPC::XML::Server

SINOPSIS

make_method --name=system.identification --helptext='Rentetan ID Sistem'
--signature=string --code=ident.pl --output=ident.xpl

make_method --base=methods/identification

DESCRIPTION

Ini adalah alat mudah untuk mencipta fail deskriptif XML untuk menentukan kaedah yang akan digunakan
diterbitkan oleh an RPC::XML::Pelayanpelayan berasaskan.

Jika pelayan ditulis sedemikian rupa sehingga kaedah yang dieksport (atau menerbitkan) adalah sebahagian daripada
menjalankan kod, maka tidak ada keperluan untuk alat ini. Walau bagaimanapun, dalam kes di mana pelayan boleh
menjadi berasingan dan berbeza daripada kod (seperti pelayan RPC berasaskan Apache), menentukan
rutin dan pengisian maklumat sokongan boleh menyusahkan.

Satu penyelesaian yang RPC::XML::Pelayan tawaran pakej adalah cara untuk memuatkan boleh diterbitkan
kod daripada fail luaran. Fail adalah dalam dialek XML mudah yang menggambarkan dengan jelas
nama yang boleh dilihat secara luaran, tandatangan kaedah, teks bantuan dan kod itu sendiri. Ini
fail boleh dibuat secara manual, atau alat ini boleh digunakan sebagai pembantu.

DIKEHENDAKI HUJAH

Tiada hujah yang diperlukan, tetapi jika tidak ada pilihan yang mencukupi yang diluluskan, anda akan melakukannya
diberitahu oleh mesej ralat.

PILIHAN

Alat ini mengenali pilihan berikut:

- membantu
Mencetak ringkasan ringkas pilihan.

--name=STRING
Menentukan nama diterbitkan bagi kaedah yang dikodkan. Inilah nama yang digunakannya
akan kelihatan kepada pelanggan pelayan.

--ruang nama=STRING
Menentukan ruang nama yang kod kaedah akan dinilai, apabila XPL
fail dimuatkan oleh contoh pelayan.

--type=STRING
Tentukan jenis untuk fail yang terhasil. "Jenis" di sini merujuk kepada sama ada bekas
tag yang digunakan dalam XML yang terhasil akan menentukan a prosedur atau kaedah. Lalai adalah
kaedah. Rentetan dianggap tidak bergantung pada huruf besar dan hanya aksara pertama ("m" atau
"p") sebenarnya dianggap.

--version=STRING
Tentukan setem versi untuk rutin kod.

--tersembunyi
Jika ini lulus, fail yang terhasil akan menyertakan tag yang memberitahu daemon pelayan
untuk tidak menjadikan rutin itu kelihatan melalui mana-mana antara muka introspeksi.

--signature=STRING [ --signature=STRING ... ]
Tentukan satu atau lebih tandatangan untuk kaedah tersebut. Tandatangan hendaklah jenis nama seperti
dibentangkan dalam dokumentasi dalam RPC::XML, dengan elemen dipisahkan oleh titik bertindih. awak
mungkin juga memisahkannya dengan ruang, jika anda memetik hujah. Pilihan ini mungkin
dinyatakan lebih daripada sekali, kerana sesetengah kaedah mungkin mempunyai beberapa tandatangan.

--helptext=STRING
Tentukan teks bantuan untuk kaedah sebagai rentetan ringkas pada baris arahan. tidak
sesuai untuk rentetan bantuan yang sangat panjang.

--helpfile=FAIL
Baca teks bantuan untuk kaedah daripada fail yang ditentukan.

--code=FAIL
Baca kod sebenar untuk rutin daripada fail yang ditentukan. Jika pilihan ini tidak
diberikan, kod dibaca daripada deskriptor fail input standard.

--output=FAIL
Tulis perwakilan XML yang terhasil ke fail yang ditentukan. Jika pilihan ini tidak
diberikan, maka output pergi ke deskriptor fail output standard.

--base=NAME
Ini adalah pilihan "semua-dalam-satu" istimewa. Jika lulus, semua pilihan lain diabaikan.

Nilai digunakan sebagai elemen asas untuk membaca maklumat daripada fail bernama
BASE.asas. Fail ini akan mengandungi spesifikasi nama, versi, status tersembunyi,
tandatangan dan maklumat kaedah lain. Setiap baris fail sepatutnya kelihatan seperti satu daripada
yang berikut:

Nama: TALI
Nyatakan nama rutin yang diterbitkan. Jika baris ini tidak muncul,
maka nilai bagi --dasar argumen dengan semua elemen direktori dialih keluar akan
terpakai.

Versi: TALI
Sediakan setem versi untuk fungsi tersebut. Jika tiada baris yang sepadan dengan corak ini
sekarang, tiada teg versi akan ditulis.

Tersembunyi: TALI
Jika ada, TALI hendaklah sama ada "ya" atau "tidak" (kes tidak penting). Jika ia adalah
"ya", maka kaedah itu ditandakan untuk disembunyikan daripada mana-mana API introspeksi.

Tandatangan: TALI
Baris ini mungkin muncul lebih daripada sekali, dan dirawat secara kumulatif. Pilihan lain
mengatasi nilai sebelumnya jika ia muncul lebih daripada sekali. Bahagian berikutan
Bahagian "Tandatangan:" diambil sebagai tandatangan yang diterbitkan untuk kaedah, dengan
elemen dipisahkan oleh ruang putih. Setiap kaedah mesti mempunyai sekurang-kurangnya satu tandatangan, jadi
kekurangan mana-mana akan menyebabkan ralat.

Fail bantuan: TALI
Menentukan fail untuk membaca teks bantuan. Ia bukan satu kesilapan jika tiada pertolongan
teks ditentukan.

Fail kod: TALI
Menentukan fail dari mana untuk membaca kod. Kod diandaikan sebagai Perl, dan
akan ditandakan sedemikian dalam fail yang dihasilkan.

Fail kod[lang]: rentetan
Menentukan fail untuk membaca kod, sambil juga mengenal pasti bahasa
kod itu ada. Ini membolehkan penciptaan a XPL fail yang merangkumi
pelaksanaan pelbagai bahasa bagi kaedah atau prosedur yang diberikan.

Mana-mana baris lain daripada corak di atas diabaikan.

Jika tiada kod telah dibaca, maka alat akan keluar dengan mesej ralat.

Output ditulis kepada BASE.xpl, mengekalkan maklumat laluan supaya
fail yang terhasil adalah betul-betul di sebelah fail sumber. Ini membolehkan binaan seperti:

make_method --base=methods/introspeksi

FAIL FORMAT DAN DTD

Format fail untuk rutin yang diterbitkan ini ialah dialek XML yang sangat mudah. Ini kurang
disebabkan XML menjadi format yang ideal daripada ketersediaan parser, memandangkan bahawa
RPC::XML::Pelayan kelas sudah mempunyai kod parser dalam teras. Menulis yang benar-benar baru
format tidak akan mendapat apa-apa.

Pengisytiharan Jenis Dokumen untuk format boleh diringkaskan dengan:

<!ELEMENT proceduredef (nama, ruang nama?, versi?, tersembunyi?,
tandatangan+, bantuan?, kod)>
<!ELEMENT methoddef (nama, ruang nama?, versi?, tersembunyi?,
tandatangan+, bantuan?, kod)>
<!ELEMENT functiondef (nama, ruang nama?, versi?, tersembunyi?,
tandatangan+, bantuan?, kod)>









Fail "rpc-method.dtd" yang disertakan dengan pengedaran mempunyai beberapa ulasan sebagai tambahan
kepada spesifikasi sebenar.

Fail adalah (buat masa ini) terhad kepada satu definisi. Ini dimulakan dengan pembukaan
tag" "," "atau" ". Ini diikuti dengan tepat satu
" " bekas yang menyatakan nama kaedah, setem versi pilihan, pilihan
bendera sembunyi-dari-introspeksi, satu atau lebih " " bekas yang menyatakan tandatangan,
pilihan" " bekas dengan teks bantuan, kemudian " " container with the
kod program sebenar. Semua teks harus menggunakan pengekodan entiti untuk simbol:

& C<&> (ampersand)
E C<<> (kurang daripada)
E C<>> (lebih besar daripada)

Proses penghuraian dalam kelas pelayan akan menyahkod entiti. Untuk membuat sesuatu
lebih mudah, alat mengimbas semua elemen teks dan mengekod entiti di atas sebelum menulis
fail.

. spesifikasi of Kod
Ini bukan "Pengaturcaraan 101 ", begitu juga "Perl khususnya yang Agak malap". Kod itu
dihantar melalui salah satu fail "*.xpl" dihantar ke "eval" tanpa sebarang pengubahsuaian
(lihat di bawah). Oleh itu, kod yang ditulis dengan buruk atau berniat jahat boleh mendatangkan malapetaka kepada anda
pelayan. Ini bukan kesalahan kod pelayan. Harga fleksibiliti sistem ini
tawaran adalah tanggungjawab di pihak pembangun untuk memastikan bahawa kod tersebut
diuji dan selamat.

Kod itu sendiri dianggap sebagai verbatim yang mungkin. Sesetengah suntingan mungkin berlaku pada bahagian pelayan,
kerana ia menjadikan kod itu sesuai untuk mencipta subrutin tanpa nama daripada. The membuat_kaedah
alat akan cuba menggunakan bahagian "CDATA" untuk membenamkan kod dalam dokumen XML, jadi
bahawa tidak ada keperluan untuk mengekod entiti atau sebagainya. Ini membolehkan terhasil *.xpl
fail boleh diuji sintaks dengan "perl -cx". Anda boleh membantu ini dengan memastikan bahawa kod
tidak mengandungi salah satu daripada dua urutan aksara berikut:

]]>

__DATA__

Yang pertama ialah penamat "CDATA". Jika ia berlaku secara semula jadi dalam kod, ia akan mencetuskan
hujung bahagian dalam penghurai. Yang kedua ialah token Perl yang biasa, yang dimasukkan
supaya baki dokumen XML tidak mengacaukan parser Perl.

CONTOH

. RPC::XML pengedaran datang dengan beberapa kaedah lalai dalam subdirektori yang dipanggil
(cukup samar) "kaedah". Setiap satu daripada ini dinyatakan sebagai satu set ("*.base",
"*.code", "*.help") fail. Fail Makefile.PL mengkonfigurasi Makefile yang terhasil sedemikian
bahawa ini digunakan untuk mencipta fail "*.xpl" menggunakan alat ini, dan kemudian memasangnya.

DIAGNOSTIK

Kebanyakan masalah keluar dalam bentuk mesej ralat diikuti dengan keluar mengejut.

EXIT STATUS

Alat keluar dengan status 0 apabila berjaya, dan 255 sebaliknya.

CATATAN

Saya tidak begitu suka pendekatan ini untuk menentukan kaedah, tetapi saya menyukai idea saya yang lain
kurang.

Gunakan make_methodp dalam talian menggunakan perkhidmatan onworks.net