iidoc Πρόγραμμα αυτόματης τεκμηρίωσης κώδικα C++

Transcript

1 iidoc Πρόγραμμα αυτόματης τεκμηρίωσης κώδικα C++ Υττεύθυ«3ςι«(θηγηπτςγοπινττιυχρκηερνο^: ΘΒό&4χςΑλεβίζος Η συγγραφή του κώδικα και η ανάλυση του προβλήματος έγινε από τον Μενέλαο Βέργη φοιτητή του τμήματος της Βιομηχανικής Πληροφορικής του Τ.Ε.Ι. της Καβάλας. Καβάλα 2005

2 Σε αυτή την πτυχιακή εργασία αναλύεται ο τρόπος που κωδικοποιήθηκε το πρόγραμμα αυτόματης τεκμηρίωσης iidoc. Το iidoc είναι ένα πρόγραμμα που παράγει ιστιοσελίδες με την τεκμηρίωση κάθε κλάσης ή συνάρτησης ενός προγράμματος. Για να γίνει αυτό εφικτό χρειάζεται ο συγγραφέας τους να παρέχει εσωτερική τεκμηρίωση μέσα σε σχόλια πριν από κάθε τέτοια δήλωση. Η λειτουργία του βασίζεται στην χρήση κάποιων λέξεων-κλειδιά που χαρακτηρίζουν πληροφορίες απαραίτητες για την τεκμηρίωση. Κάθε λέξη-κλειδί έχει εναλλακτικά ονόματα και μπορεί ο χρήστης να διαλέξει ένα από αυτά. Μετά από τις λέξεις-κλειδιά μπορεί να υπάρχει κείμενο που να αναφέρεται στην έννοια της λέξης με αποτέλεσμα να τεκμηριωθεί ο κώδικας. Η τεκμηρίωση χρειάζεται αρκετές πληροφορίες για να είναι ολοκληρωμένη. Για τον παραπάνω λόγο ο προγραμματιστής αναγκάζεται να χρησιμοποιήσει αρκετές λέξεις-κλειδιά ώστε να προσφέρει μια ολοκληρωμένη τεκμηρίωση. Το iidoc έχει προγραμματιστεί με τέτοιο τρόπο ώστε να είναι ελαστικό με την δήλωση των λέξεων-κλειδιά αντιθέτως με πολλά από τα υπόλοιπα προγράμματα αυτόματης τεκμηρίωσης. Μπορεί να αναγνωρίσει μία λέξη-κλειδί που όλα τα φωνήεντά της τονίζονται ή το αντίθετο, που το κάθε γράμμα της διαχωρίζεται με το επόμενο με κενά, ακόμα και όταν ελληνικά και λατινικά γράμματα χρησιμοποιούνται για την ίδια λέξη. Η μόνη απαίτηση που υπάρχει για την λειτουργία του είναι η λέξη-κλειδί που χρησιμοποιείται να έχει ίδια εμφάνιση με την απαιτούμενη στην κεφαλαία μορφή της, απαλλαγμένη από τόνους και κενά. Η ελαστικότητα του iidoc συνεχίζεται και στην θέση δήλωσης των λέξεων-κλειδιά. Μπορούν να τοποθετηθούν σε οποιαδήποτε θέση και με οποιαδήποτε σειρά μέσα στα σχόλια, κάτι που απαγορεύεται από άλλα προγράμματα. Όταν συναρτήσεις χρησιμοποιούν συναρτήσεις ή χρησιμοποιούνται από άλλες τότε παράγονται υπέρσυνδέσεις. Με την χρήση αυτών των υπέρ-συνδέσεων ο αναγνώστης μπορεί να μεταβεί στις αντίστοιχες συναρτήσεις. Για την ευκολότερη πλοήγηση του αναγνώστη μέσα στις ιστοσελίδες παρέχεται μία κεντρική σελίδα που περιέχει όλες τις σελίδες τεκμηρίωσης. Με την παραπάνω σελίδα ο αναγνώστης μπορεί να αποκτήσει μία γενική εικόνα του προγράμματος. Για την καλύτερη ανάγνωση του κώδικα που περιέχεται, εμπλουτίζεται το αντίστοιχο κείμενο με γράμματα έντονα για τις δεσμευμένες λέξεις, μπλε για τα κείμενα και μοβ με πλάγια μορφή για τα σχόλια. Αντίθετα με άλλα προγράμματα αυτόματης τεκμηρίωσης, το iidoc δεν απαιτεί την εισαγωγή όλων των αρχείων κώδικα που χρησιμοποιούνται για ένα πρόγραμμα. Το μόνο που χρειάζεται είναι η εισαγωγή του κεντρικού αρχείου που περιέχει τα υπόλοιπα. Το iidoc έχει προγραμματιστεί έτσι ώστε να αναγνωρίζει ποια αρχεία εισάγονται κάθε φορά στον κώδικα και τα τεκμηριώνει και αυτά με την σειρά τους. Το iidoc συνοδεύεται από έναν οδηγό εκτέλεσης που παρέχει εύκολη και γρήγορη εκτέλεση και ένα script για τον Editor της C++ που εισάγει πρότυπα σχόλια για συναρτήσεις και κλάσεις. Η τεκμηρίωση που παράγεται μπορεί να είναι σε ελληνική ή αγγλική γλώσσα.

3 Περιεχόμενα :χόμενα 3 Εισαγωγή Η αναγκαιότητα της τεκμηρίωση Τα είδη της τεκμηρίωσης Η αναγκαιότητα της στον προγραμματισμό 7 Η τεκμηρίωση στον προγραμματισμό Μορφές τεκμηρίωσης Προγράμματα αυτόματης τεκμηρίωσης Το πρόγραμμα CCDoc Σύνταξη των σχολίων του CCDoc Το πρόγραμμα ScanDoc Σύνταξη των σχολίων του ScanDoc Το πρόγραμμα Doc Σύνταξη των σχολίων του Doc++ 12 Το πρόγραμμα MDoc Η αρχική ιδέα Το πρόγραμμα Οι απαιτήσεις λογισμικού Διαγράμματα ροής Ανάλυση προβλήματος Το συντακτικό της γλώσσας C Το συντακτικό μίας συνάρτησης Το συντακτικό μίας κλάσης Ανάγνωση αρχείων Τρόπος χρήσης των αρχείων Αποθήκευση τεκμηρίωσης Τ ρόπος εμφάνισης κειμένου Ονόματα αποθήκευσης αρχείων Ανάγνωση σχολίων Περιεχόμενα σχολίων Τ ρόπος ανάγνωσης σχολίων 22

4 Τύπος δηλώσεων Αναγνώριση παραμέτρων 21 Κώδικας γενικής χρήσης του iidoc Εισαγωγή Δημιουργία Log αρχείων Η κωδικοποίηση Η κλάση Log Διαχείριση των παραμέτρων ενός προγράμματος Η κωδικοποίηση Προσθήκη νέων παραμέτρων στην κλάση Ορισμός του τρέχοντος φακέλου από τον χρήστη Η κλάση Switches Ανάγνωση αρχείων κειμένου Η κωδικοποίηση Η κλάση file Συναρτήσεις διαχείρισης κειμένων Αντιμετάθεση κειμένων Έλεγχος διαχωριστικού Μετατροπή ονόματος αρχείου σε όνομα που που αναγνωρίζει το Dos Έλεγχος εάν ένας χαρακτήρας είναι ελληνικός Μετατροπή ενός κειμένου σε κεφαλαία, αναγνώριση λέξεων Προσπέραση κενών χαρακτήρων Εύρεση και επιστροφή λέξης από κείμενο Έλεγχος ύπαρξης ενός κειμένου σε ένα άλλο Αντιστροφή ενός κειμένου Αναγνώριση ενός κειμένου από το τέλος προς την αρχή Ανάκτηση κειμένου μέχρι την εμφάνιση κάποιου χαρακτήρα ή της αλλαγής γραμμής Ανάγνωση κειμένου μέσα από σχόλια μέχρι την εμφάνιση Διαχείριση κειμένων με δυναμική παραχώρηση μνήμης και ταξινόμηση τους Η κωδικοποίηση Συναρτήσεις διαχείρισης κειμένων με HTML 60

5 4.6.1 Αφαίρεση ενός ζευγαριού tags Μορφοποίηση κειμένου για την εμφάνιση σε ιστοσελίδα κώδικα C Ο κώδικας Μετατροπή λέξεων σε υπέρ-συνδέσεις 70 Η κωδικοποίηση του MDoc Εισαγωγή Ανάγνωση σχολίων Λειτουργία ανάγνωσης σχoλίωv(comment::readtext) Ανάκτηση ονόματος και κώδικα δηλώσεων της C Ανάκτηση ονόματος(ίυησίίοη,class::getname) Ανάκτηση παραμέτρων από συναρτήσεις (function::getparams) Ανάκτηση κώδικα (function,class::getcode) Ανάγνωση αρχείων(ρατεθ::parse) Αποθήκευση τεκμηpίωσης(parser::make... Html) 88 Μέθοδοι και ιδέες για αναβάθμιση Εισαγωγή Πρόσθεση νέου διακότπη(παράμετρος προγράμματος) Πρόσθεση νέου πεδίου στην τεκμηρίωση Πρόσθεση νέου τύπου συνάρτησης για κλάση Ιδέες αναβάθμισης Αναβάθμιση του κώδικα lidoc σε γενικό πρόγραμμα τεκμηρίωσης Απαιτήσεις Συγγραφή ενός κειμενογράφου για τον ορισμό των αυτόματων σχολίων Απαιτήσεις 99 Παράρτημα A 101 Παράρτημα Β 102 Παράρτημα Γ 250 Βιβλιογραφία 260

6 κε(ράλαιο 1 Εισαγωγή 1.1 Η αναγκαιότητα της τεκμηρίωσης Με την εμφάνιση του ηλεκτρονικού υπολογιστή αναπτύχθηκαν και δεκάδες προγράμματα που αξιοποιούσαν τις δυνατότητες του. Η χρήση του τότε ήταν περιορισμένη και τα προγράμματα λίγα και γραμμένα για συγκεκριμένες εργασίες. Η εμφάνιση τους στο ευρύ κοινό δεν ήταν εφικτή. Η χρήση τους γινόταν από εξειδικευμένους επαγγελματίες που γνώριζαν καλά την λειτουργία τους. Όταν ο ΗΛ' εξαπλώθηκε η ανάγκη μιας μορφής τεκμηρίωσης κρίθηκε αναγκαία. Κάθε Η/Υ συνοδευόταν από ένα τέτοιο κείμενο τεκμηρίωσης(τη3πυ3ΐ). Αυτό βοήθησε στο να μπορούν να κατανοήσουν την λειτουργία του και απλοί άνθρωποι χωρίς την ανάγκη εκπαίδευσης στο αντικείμενο, το οποίο συνεχίστηκε και στα προγράμματα. Κάθε πρόγραμμα προσέφερε και ένα κείμενο που βοηθούσε τον χρήστη να κατανοήσει και να χρησιμοποιήσει στο έπακρο τις λειτουργίες του Τα είδη της τεκμηρίωσης Μπορούμε να χωρίσουμε την τεκμηρίωση σε τρία μέρη: Τεκμηρίωση λειτουργίας ενός προγράμματος Τεκμηρίωση χρήσης κώδικα Τεκμηρίωση τροποποίησης κώδικα Τα δύο τελευταία είδη ανήκουν στον προγραμματισμό. Το πρώτο από αυτά χαρακτηρίζεται από μια περιγραφή, τις εισόδους-εξόδους χωρίς όμως τον κώδικα. Χρησιμοποιείται για να δείξει στον προγραμματιστή τον τρόπο λειτουργίας και τι κάνει. Βρίσκει εφαρμογή σε διανεμόμενο κώδικα και σε εταιρίες που φτιάχνουν βιβλιοθήκες. Το δεύτερο περιέχει τα παραπάνω αλλά περιέχει επίσης κώδικα και τον τρόπο μεταβολής. Χρησιμοποιείται κατά κόρον για ατομική χρήση και σε ομαδική εργασία Η αναγκαιότητα της στον προγραμματισμό

7 Προγραμματίζοντας συνήθως ο προγραμματιστής δεν μεριμνά στο να τεκμηριώνει το πρόγραμμά του, αλλά προσπαθεί να το κάνει να δουλεύει. Με αυτό το σκεπτικό όμως, μη μπορώντας να θυμάται όλο τον κώδικα, συχνά ανατρέχει σε προηγούμενες ενότητες για να θυμηθεί τον τρόπο που πρέπει να συνεχίσει. Όταν πάλι αφήνει το πρόγραμμά του για κάποιο καιρό και αργότερα θελήσει να το συνεχίσει, δεν μπορεί να θυμηθεί για πιο λόγο το έχει γράψει με αυτόν τον τρόπο! Μπορεί κάποιος να αριθμήσει δεκάδες περιστατικά που μια μορφή τεκμηρίωσης θα είχε βοηθήσει τον προγραμματιστή στην δουλεία του. Η τεκμηρίωση όμως δεν χρησιμοποιείται μόνο από μεμονωμένους προγραμματιστές. Μεγάλη χρήση βρίσκει και σε ομάδες προγραμματιστών που δουλεύουν σε ένα αντικείμενο. Ίσως χωρίς τεκμηρίωση σε αυτή την περίπτωση να μην μπορέσουν ποτέ να φτάσουν σε ένα τελικό αποτέλεσμα.

8 κε(ράλαιο 2 Η τεκμηρίωση στον προγραμματισμό 2.1 Μορφές τεκμηρίωσης Χωρίς την ύπαρξη ενός προτύπου τεκμηρίωσης, ο κάθε προγραμματιστής ή Software House παράγει ένα δικό του. Γενικά όμως η τεκμηρίωση μπορεί να διαιρεθεί σε δύο κατηγορίες, την εσωτερική τεκμηρίωση και την εξωτερική. Η πρώτη κατηγορία βρίσκεται σε μορφή σχολίων μέσα στον κώδικα ενώ η δεύτερη σε ξεχωριστό αρχείο. Και στις δύο περιπτώσεις όμως οι πληροφορίες που αποθηκεύονται είναι σχεδόν παντού οι ίδιες: Όνομα προγραμματιστή Ημερομηνία συγγραφής Περιγραφή λειτουργίας Είσοδοι έξοδοι Τι χρησιμοποιούν Από τι χρησιμοποιούνται Η εσωτερική τεκμηρίωση ενώ παρέχει ένα σημαντικό πλεονέκτημα, να μην χρειάζεται να ανατρέχει σε άλλο αρχείο ο προγραμματιστής κατά την συγγραφή του κώδικα, υστερεί στο διάβασμα του κώδικα από τρίτους. Μια χρήση και των δύο είναι ιδανική. 2.2 ΠρογράμμοσααυτόμοσηςτΕκμηρωσης Επειδή πολλοί είναι οι προγραμματιστές που προτιμούν να κάνουν εσωτερική τεκμηρίωση για τον λόγο της παραπάνω ενότητας, έχουν κυκλοφορήσει προγράμματα που διαβάζουν αυτά τα σχόλια και τα μετατρέπουν σε εξωτερική τεκμηρίωση. Για να λειτουργήσουν αυτά τα προγράμματα όμως, πρέπει ο συγγραφέας των σχολίων να ακολουθήσει κάποιο πρότυπο. Το πρότυπο αυτό ορίζεται από το πρόγραμμα που θα χρησιμοποιηθεί. Συνήθως το πρότυπο αυτό περιλαμβάνει κάποιες δεσμευμένες λέξεις κλειδιά. 221 ToττpσγpqJμαccD oc

9 Ένα από τα προγράμματα που προαναφέρθηκαν είναι και το ccdoc.δημιουργός του είναι ο Joe Linoff. To πρόγραμμα ccdoc είναι ένα εργαλείο το οποίο παράγει αυτόματα HTML τεκμηριώσεις από προγράμματα C++. Δημιουργήθηκε για να βοηθήσει τη συνεργασία μεταξύ χρηστών και δημιουργών. Παρακάτω αναφέρονται τα προτερήματα που προσφέρει η χρήση του CcDoc : Είναι εύκολο στη χρήση. ο Δεν υπάρχει πρόγραμμα εγκατάστασης ο Είναι εύκολα εκτελέσιμο αφού με μία απλή γραμμή εντολών μπορεί κανείς να τεκμηριώσει ολόκληρα προγράμματα Είναι ελεγχόμενο ο Μπορεί κανείς να ελέγξει ποιόν τομέα του κώδικα επεξεργάζεται το CcDoc ο Μπορεί κανείς να παράγει τον δικό του τρόπο εμφάνισης των αποτελεσμάτων αλλάζοντας την βάση (αρχείο) στο οποίο είναι αποθηκευμένος ο πρότυπος τρόπος, ο Μπορεί κανείς να τροποποιήσει τον πηγαίο κώδικα για να προσθέσει ή να αφαιρέσει κάποια χαρακτηριστικά Είναι ανθεκτικός ο Χρησιμοποιεί STL διεξοδικά Σύ\παξητϋϋν σχολίων του ccdoc Τα σχόλια του ccdoc έχουν καταταχθεί σε τρία τμήματα :στη μικρή περιγραφή, στη εκτενέστερη και στον ορισμό ιδιοτήτων. Η μικρή περιγραφή παρέχει μια σύντομη περίληψη που εμφανίζεται στον πίνακα των περιεχομένων. Αντίθετα η εκτενέστερη περιγραφή των σχολίων είναι μια πιο αναλυτική περιγραφή της οντότητας. Οι δύο αυτές περιγραφές διαχωρίζονται από τα tags ή από ένα περιοδικό space, tab ή αλλαγή γραμμής. Στην πραγματικότητα υπάρχουν δύο είδη μικρής περιγραφής που επιτρέπονται στο CcDoc.Zto πρώτο είδος μικρής περιγραφής ο τερματισμός της γίνεται με ένα tag ή από κάποια περίοδο ακολουθούμενη με κενό (space), tab ή αλλαγή γραμμής (newline). Παρακάτω φαίνεται ένα τέτοιο παράδειγμα : * The default (-jdsds) short description terminates * with a directive or period followed by space, tab * or new line. This is the start of the long description.

10 * This is la o re of the long description. V Τα σχόλια με έντονα γράμματα αποτελούν την εκτενέστερη περιγραφή,ενώ τα υπόλοιπα είναι η μικρή περιγραφή. Το άλλο είδος της περιγραφής είναι παραδοσιακή σύνταξη σχολίων το ΟοΟοο.Σύμφωνα με αυτή όλα τα σχόλια είναι μικρής περιγραφής μέχρι να υπάρξει τέλος παραγράφου (κενή γραμμή). Παρακάτω φαίνεται ένα παράδειγμα παραδοσιακής σύνταξης : * The -nojdsds short description terminates * with a blank line. This is the NOT the start of the long * description. * * This is the start of the long description. V Τα σχόλια με έντονα γράμματα αποτελούν την εκτενέστερη περιγραφή,ενώ τα υπόλοιπα είναι η μικρή περιγραφή. Για περισσότερες πληροφορίες μπορείτε να ανατρέξετε στη σελίδα : [Joe Linoff2004] To Πρόγραμμα ScanDoc Δημιουργός αυτού του προγράμματος είναι ο Talin. Το ScanDoc είναι ένα Perl script το οποίο εξετάζει λεπτομερώς τον πηγαίο κώδικα σε C++ για ειδικά διαμορφωμένα σχόλια και παράγει ευπαρουσίαστη και οργανωμένη τεκμηρίωση. Το ScanDoc έχει σχεδιαστεί με τέτοιο τρόπο ώστε να παράγει υψηλής ποιότητας τεκμηρίωση όσο πιο εύκολα γίνεται. Επίσης δεν παράγει τεκμηρίωση μόνο από τις προκαθορισμένες δηλώσεις των σχολίων του χρήστη αλλά και διαβάζοντας τον κώδικα από τις δηλώσεις στη C++. Σε αντίθεση με κάποια άλλα προγράμματα παρόμοιας τεκμηρίωσης, το ScanDoc παράγει τεκμηρίωση η εμφάνιση της οποίας μπορεί να διαμορφωθεί από τον χρήστη. Παρακάτω αναφέρονται τα προτερήματα της χρήσης του ScanDoc: Είναι μετακινούμενο Αυτό σημαίνει ότι το πρόγραμμα μπορεί να εκτελεστεί σε οποιοδήποτε ηλεκτρονικό υπολογιστή. Είναι εύκολο στη χρήση 10

11 Εφόσον εγκατασταθεί είναι και εύκολο στη χρήση, το μόνο που χρειάζεται είναι η εισαγωγή κάποιων παραμέτρων. Είναι βολικό Τα σχόλια του ScanDoc μπορούν να γραφτούν πολύ εύκολα. Είναι μετατρέψιμο Είναι νοήμον Το ScanDoc καταλαβαίνει ένα ευρύ φάσμα σύνταξης σε C++ συμπεριλαμβανομένων και των φίλων αναρτήσεων, των templates, φωλιασμένων κλάσεων κτλ. Είναι γρήγορο Είναι ευέλικτο Οι λειτουργίες μπορούν να ομαδοποιηθούν σύμφωνα με τις επιθυμίες του χρήστη Σύνταξη των σχολίων του ScanDoc Για τη χρήση του ScanDoc θα πρέπει στον πηγαίο κώδικα να χρησιμοποιηθούν συγκεκριμένου είδους σχόλια. Τα σχόλια που αναγνωρίζει ατό το πρόγραμμα είναι δύο ειδών :αυτά που αρχίζουν με /** και αυτά που αρχίζουν με //*.Το πρώτο είδος αναφέρεται σε σχόλια πολλών γραμμών ενώ το δεύτερο σε σχόλια μιας γραμμής. Κάθε φορά μετά τη δήλωση έναρξης σχολίων πρέπει να ακολουθεί ένα κενό. Κάθε φορά που το ScanDoc διαβάζει ειδικό σχόλιο γνωρίζει ότι η δήλωση(συνάρτηση, μέθοδος, κλάση, μεταβλητή) που ακολουθεί πρέπει να τεκμηριωθεί. Οποιαδήποτε δήλωση της οποίας δεν προηγείται ειδικό σχόλιο θα παραληφθεί από το εξαγόμενο αρχείο. Αυτό δίνει τη δυνατότητα στον χρήστη να έχει ιδιωτικές συναρτήσεις και κλάσεις οι οποίες δε θα εμφανιστούν στην τεκμηρίωση. Για τις ιδιωτικές συναρτήσεις και κλάσεις μπορούν να χρησιμοποιηθούν τα συνηθισμένα σχόλια τύπου C ή C++ αφού αυτά δε θα συμπεριληφθούν στην τεκμηρίωση αλλά ούτε την επηρεάζουν. Παρακάτω ακολουθεί παράδειγμα σχολίων: /** Documentation for class Foo */ class Foo : private class Bar int Baz( void ); ; Για περισσότερες πληροφορίες μπορείτε να ανατρέξετε στη σελίδα : [ Talin 2000 ] Το πρόγραμμα DOC++ Δημιουργοί αυτού του προγράμματος είναι οι Malte Zockler, Roland Wunderling,. 11

12 Σκοπός του προγράμματος είναι να προσφέρει στον προγραμματιστή ένα εργαλείο για να γράφει υψηλής ποιότητας τεκμηρίωση κρατώντας τον δημιουργό αφοσιωμένο στην ανάπτυξη του προγράμματος. Για να συμβεί αυτό είναι απαραίτητο ο προγραμματιστής να μπορεί να εισάγει την τεκμηρίωση κατευθείαν μέσα στον κώδικα. Ο μόνος τρόπος τρόπος λοιπόν είναι να εισάγουμε την τεκμηρίωση στα σχόλια του προγράμματος. Παρακάτω αναφέρονται τα προτερήματα της χρήσης του DOC++ : Η τεκμηρίωση είναι καλά δομημένη Η δημιουργία αρχείου πλοήγησης παρέχει εύκολη πρόσβαση σε όλα τα τμήματα της τεκμηρίωσης. Αυτόματη δημιουργία εικόνας για την ιεραρχία των κλάσεων Σύνταξη σχολίων του DOC++ Υπάρχουν δύο ειδών σχόλια που μπορεί να έχει κάποιο πρόγραμμα. Το ένα είδος είναι εκείνο που χρησιμοποιεί ο προγραμματιστής για να θυμάται τον τρόπο ανάπτυξης του προγράμματος. Το άλλο είδος είναι η τεκμηρίωση των κλάσεων, των συναρτήσεων κτλ ώστε ο ίδιος ο προγραμματιστής ή και οποιοσδήποτε άλλος να μπορεί να χρησιμοποιήσει τον κώδικα αργότερα. Σύμφωνα με το JavaDoc τα σχόλια τεκμηρίωσης παρουσιάζονται με τους παρακάτω τρόπους /**... */ ///... Οι αντιπροσωπεύουν τα σχόλια για τον κώδικα της δήλωσης που θα ακολουθήσει. Για περισσότερες πληροφορίες μπορείτε να ανατρέξετε στη σελίδα : [Roland Wunderling 2003 ] 12

13 κε(ράλαιο 3 To πρόγραμμα ildoc 3.1 Η αρχική ιδέα Το τμήμα της Βιομηχανικής Πληροφορικής του Τ.Ε.Ι. της Καβάλας αποφάσισε να παράγει ένα πρότυπο εσωτερικής τεκμηρίωσης. Αυτό θα βοηθήσει τους σπουδαστές του τμήματος να κατανοήσουν τον τρόπο εργασίας σε παραγωγικές μονάδες. Υιοθετώντας αυτό το πρότυπο θα υπάρχει μια ομοιογένεια στον κώδικα που παράγεται και η ένταξη των σπουδαστών στον παραγωγικό τομέα θα γίνει ευκολότερη. 3.2 Το πρόγραμμα Για την κάλυψη της παραπάνω ανάγκης κρίθηκε αναγκαία η συγγραφή ενός προγράμματος που θα καταλαβαίνει το πρότυπο αυτό και θα το μετατρέπει σε εξωτερική τεκμηρίωση. Τροφοδοτώντας το πρόγραμμα με το όνομα του αρχείου προς ανάγνωση θα αναγνωρίζει τις δηλώσεις και θα εξάγει αρχεία HTML με την τεκμηρίωση. Η εξαγωγή των εσωτερικών σχολίων σε σελίδες HTML θα κάνει ευκολότερη την πλοήγηση του αναγνώστη μέσα από της δηλώσεις. Ο προγραμματιστής που θα θέλει να χρησιμοποιήσει το πρόγραμμα θα πρέπει απλώς να εισάγει σχόλια, πριν από κάθε δήλωση, που να χαρακτηρίζουν την ίδια την δήλωση. Χαρακτηριστικά της δήλωσης που αναφέρονται σε άλλες δηλώσεις θα μετατρέπονται σε υπέρσυνδέσεις ( hyperlinks ) που με ένα απλό κλικ του ποντικιού ο αναγνώστης θα μεταφέρεται εκεί αυτόματα. Μια τέτοια αυτοματοποίηση ελπίζουμε να παροτρύνει τους σπουδαστές να υιοθετήσουν το πρότυπο αυτό. 3.3 Οι απαιτήσεις λογισμικού Οι απαιτήσεις είναι το πρώτο κομμάτι μιας εργασίας και το ποίο σημαντικό. Σηματοδοτούν την έναρξη και ορίζουν την λήξη. Να γραφεί πρόγραμμα που να διαβάζει αρχεία κειμένου που περιέχουν κώδικα γραμμένο σε C++ και να εξάγουν αρχεία HTML με την τεκμηρίωση του. Ο κώδικας θα περιέχει σχόλια πριν από κάθε δήλωση που θα την χαρακτηρίζουν. Η έναρξη και η λήξη των σχολίων σηματοδοτείται από μία συνεχή εμφάνιση του χαρακτήρα 7. Μέσα στα σχόλια θα υπάρχουν δεσμευμένες λέξεις που μετά την εμφάνιση τους θα αρχίζει η ανάγνωση των ιδιοτήτων της δήλωσης. Η έναρξη τους θα χαρακτηρίζεται από τον και η λήξη τους από τον χαρακτήρα ϊ. 13

14 Για κάθε ιδιότητα υπάρχουν διαφορετικές λέξεις που μπορούν να εμφανιστούν και να σηματοδοτήσουν την έναρξη της. Ο χρήστης θα πρέπει να μπορεί να χρησιμοποιήσει όποια λέξη κρίνει σωστή. Οι λέξεις με την σημασία τους και τα εναλλακτικά ονόματα βρίσκονται στον πίνακα 1. Ο κώδικας της δήλωσης αρχίζει μετά από τον τερματισμό των σχολίων και τερματίζει μετά την εμφάνιση του ονόματος της σε σχόλια. Με τα δεδομένα που υπάρχουν στα σχόλια θα πρέπει να δημιουργούνται HTML σελίδες με την τεκμηρίωση της δήλωσης και τον αντίστοιχο κώδικα. Τα πρότυπα των HTML σελίδων υπάρχουν στο παράρτημα Γ. Όταν μία δήλωση αναφέρεται σε μία άλλη δήλωση της οποίας το όνομα υπάρχει στα σχόλια, ο χρήστης θα πρέπει να μπορεί να μεταβεί σε αυτήν μέσω την χρήση υπέρ-σύνδεσης. Ο κώδικας που θα εμφανίζεται στην σελίδα HTML θα πρέπει να έχει την εμφάνιση που έχει στον C++ Editor. Θα πρέπεί να υπάρχει μια κεντρική σελίδα με όνομα index.html που θα έχει όλες τις συνδέσεις με τις υπόλοιπες σελίδες. Τα σχόλια που υπάρχουν μέσα στον κώδικα πρέπει να εμφανίζονται και στο πεδίο παρατηρήσεις της τεκμηρίωσης. Να γίνεται αυτόματη εισαγωγή άδειων σχολίων στον Editor με την πληκτρολόγηση Κ κενό και Σ κενό. Το πρόγραμμα θα πρέπει να γραφτεί σε C και να λειτουργεί κάτω από το περιβάλλων MS-Dos. Οι παράμετροι που θα ορίζουν το όνομα των αρχείου που θα γίνει η τεκμηρίωση, τον τρόπο τεκμηρίωσης και ότι φανεί χρήσιμο θα εισάγονται μέσω την γραμμή εντολών του MS-Dos. Για την χρήση του προγράμματος από τα Windows θα πρέπει να γραφτεί ένας wizard που με απλά βήματα θα οδηγεί τον χρήστη στην εκτέλεση του προγράμματος Διαγράμματα Ροής Δεδομένων Μηδενικό Επίπεδο 14

15 1ο Επίπεδο Οντ 1 15

16 3.4 Ανάλυση προβλήματος Εδώ θα αναλυθεί το πρόβλημα που παρουσιάστηκε στις απαιτήσεις λογισμικού. Κάθε παράγραφος είναι αφιερωμένη σε ένα κομμάτι του προβλήματος. Αυτή η ανάλυση θα βοηθήσει τον αναγνώστη να κατανοήσει την λειτουργία του προγράμματος Το συντακτικό της γλώσσας C++ Οι απαιτήσεις λογισμικού εμφανίζουν ένα πρόγραμμα που διαβάζει εξωτερικά αρχεία. Η δομή αυτών των αρχείων είναι μεταβλητή. Ένα αρχείο γραμμένο για την γλώσσα προγραμματισμού C++ δεν είναι ποτέ γραμμένο σειριακά λόγο του αντικειμενοστραφή χαρακτήρα της. Παρατηρώντας όμως ένα τέτοιο αρχείο, εύκολα κάποιος διακρίνει τις επιμέρους δομές που εμφανίζονται μέσα σε αυτό. Οι κλάσεις, οι συναρτήσεις, οι δηλώσεις τύπων και άλλες δομές έχουν ένα συγκεκριμένο συντακτικό που μπορούμε να το χρησιμοποιήσουμε Το συντακτικό μιας συνάρτησης Κάθε συνάρτηση χαρακτηρίζεται από ένα όνομα. Αυτό το όνομα μπορεί να είναι ένας απλός ορμαθός χαρακτήρων ή συνοδευόμενο από το όνομα της κλάσης που ανήκει. void funct(); void ClassName::funct() ; Για να υπάρχει μια μοναδικότητα στα ονόματα των συναρτήσεων θα θεωρηθεί ότι το όνομα τους περιέχει και το όνομα της κλάσης. Πριν το όνομα, ορίζεται ο τύπος της συνάρτησης ή και κάποιο χαρακτηριστικό όπως το inline. Για αυτό και για το ότι ένας δημιουργός δεν έχει τύπο, δεν μπορούμε να ξέρουμε σε ποίο αριθμό λέξεων από την αρχή της συνάρτησης υπάρχει το όνομα της. Η λύση είναι να αναγνωρίσουμε ως όνομα την λέξη που υπάρχει πριν τις παρενθέσεις. Μέσα στις παρενθέσεις που ακολουθούνται από το όνομα υπάρχουν ορίσματα. Τα ορίσματα διαχωρίζονται με κόμμα. Υπάρχουν όμως ορίσματα που έχουν και αυτά παρενθέσεις, πρέπει να δοθεί ιδιαίτερη προσοχή να μη γίνει σύγχυση με τις βασικές παρενθέσεις. void funct(const int x, void funct2 (*isr) (... )) Μετά TO τέλος των παρενθέσεων ακολουθεί ένα ερωτηματικό ή ένα άγκιστρο. Εάν ακολουθεί ερωτηματικό η δήλωση της συνάρτησης τελείωσε, ενώ εάν ακολουθεί άγκιστρο ξεκινάει η δήλωση του κώδικα. Ο κώδικας τελειώνει, σύμφωνα με τις απαιτήσεις με το όνομα της συνάρτησης μέσα σε σχόλια. void ClassName::funct() //ClassName::funct 16

17 Η main είναι και αυτή μια συνάρτηση αλλά η ανάλυση της πρέπει να αποθηκευτεί ξεχωριστά. Ο συγγραφέας της δεν πρέπει να την ξεχωρίσει σαν να είναι άλλη συνάρτηση αντίθετα πρέπει εμείς να την αναγνωρίσουμε και να συμπεριφερθούμε ανάλογα ΤΟ συντακτικό μιας κλάσης Κάθε κλάση ξεκινάει με την δήλωση class και ακολουθεί το όνομα της. Εάν μία κλάση κληρονομεί χαρακτηριστικά από μία άλλη τότε υπάρχεί μία άνω-κάτω τελεία και ακολουθεί το όνομα της κλάσης. Εάν όχι τότε ακολουθεί ένα άγκιστρο. class classname otherclass class classname! Και στις δύο περιπτώσεις το όνομα παραμένει ίδιο. Ανάμεσα από τα άγκιστρα που υπάρχουν στην κλάση περικλείονται οι δηλώσεις της. Οι δηλώσεις αυτές χωρίζονται σε τρεις κατηγορίες: private :. Περιέχουν δηλώσεις που δεν μπορούν να γίνουν γνωστές έξω. Pioblic :. Περιέχουν δηλώσεις που μπορούν να γίνουν γνωστές έξω. Protected :. Περιέχουν δηλώσεις που δεν μπορούν να γίνουν γνωστές έξω, αλλά μπορούν να γίνουν γνωστές στις κλάσεις που την κληρονομούν. Όσες δηλώσεις ακολουθούν μία από τις παραπάνω κατηγορίες ανήκουν σε αυτή μέχρι να εμφανιστεί καινούρια κατηγορία. Στην περίπτωση που εμφανιστούν πρώτα δηλώσεις χωρίς να προηγείται κατηγορία τότε αυτές υπάγονται στην κατηγορία private. class classname int x; char y ; piiblic: int funct() ; protected: dotoble funct2 () //private δηλώσεις, //private δηλώσεις. //public δηλώσεις. //prσtected δηλώσεις. ; Μέσα στις κατηγορίες υπάρχουν δηλώσεις για μεταβλητές, για σταθερές και για συναρτήσεις. Μετά από οποιαδήποτε δήλωση μπορεί να ακολουθούν σχόλια. Αυτά τα σχόλια θα πρέπει να περιληφθούν στην τεκμηρίωση στο κομμάτι των παρατηρήσεων. Μίας κλάσης το τέλος ορίζεται με τον ίδιο τρόπο όπως της συνάρτησης, την εμφάνιση του ονόματος της σε σχόλια. class classname ;//classname 17

18 Όταν υπάρχει 0 opn(struct) η κατάσταση είναι παρόμοια απλά δεν υπάρχουν κατηγορίες. Η εξορισμού κατηγορία είναι η p io b lic Ανάγνωση αρχείων Ένα πρόγραμμα γραμμένο για την γλώσσα προγραμματισμού C++ έχει ένα αρχείο που περιέχει τουλάχιστον μια συνάρτηση, την main. Σε πιο σύνθετα προγράμματα υπάρχουν και άλλα αρχεία που ονομάζονται Headers. Αυτά τα αρχεία εισάγονται στο βασικό αρχείο με την εντολή του precompiler #inlude. Η εντολή αυτή εισάγει στο σημείο της δήλωσής της, τον κώδικα που υπάρχει στο αρχείο που περικλείεται με εισαγωγικά. #include "header.χχχ" Τρόπος χρήσης των αρχείων Για να μην διαβάζουμε γραμμή-γραμμή ένα αρχείο θεωρείται σωστή η μεταφορά του σε ένα string χαρακτήρα-χαρακτήρα. Αργότερα μπορούμε να διαβάσουμε αυτό το string και να το χρησιμοποιήσουμε. Κάθε φορά που εμφανίζεται η εντολή #include θα πρέπει να διαβαστεί το εισαγόμενο αρχείο πριν προχωρήσουμε στην υπόλοιπη ανάγνωση. Έμφαση πρέπει να δοθεί στην χρήση περισσότερης από μίας εισαγωγής ίδιου αρχείου. Μπορεί να πέσουμε σε ατέρμονα βρόγχο. Ο συγγραφέας μπορεί να εισάγει ένα αρχείο μέσα στο ίδιο αρχείο αλλά και να εισάγει αρχείο, που αυτό με την σειρά του εισάγει το πρώτο. filgl ^f > > " f ile l" - iinclude " f ile 3 " iiiiclu d e " file Z -I Ευτυχώς για εμάς στο ίδιο λάθος μπορεί να πέσει και ο compiler της C++. Για την λύση αυτού του προβλήματος η C++ χρησιμοποιεί τις εντολές #define, #ifndef και #endif του precompiler. Στην αρχή κάθε τέτοιου αρχείου γίνεται η χρήση της εντολής #ifndef ακολουθώντας ένα όνομα. Αργότερα γίνεται η χρήση της εντολής #define ακολουθώντας το ίδιο όνομα. Στο τέλος του αρχείου υπάρχεί η εντολή # e n d if.σ ε κάθε χρήση της εντολής #define Ο precompiler κρατάει το όνομα και όταν συναντήσει την εντολή #ifndef με το ίδιο όνομα περνάει στην εντολή #endi f. 18

19 filel p iifndef filel_h idefine filel h ίinclude "filel"... #endi f Γla περισσότερες πληροφορίες σχετικά με τον precompiler ανατρέξτε σε κάποιο εγχειρίδιο Αποθήκευση τεκμηρίωσης Στις απαιτήσεις λογισμικού γίνεται αναφορά για αποθήκευση σε μορφή HTML. Το πρόγραμμα θα πρέπει να αποθηκεύει την τεκμηρίωση με κατάληξη.html. Ένα κείμενο γραμμένο σε HTML μορφή μπορεί να έχει διάφορες ιδιότητες. Εντολές που ονομάζονται tags μορφοποιούν το χρώμα, την γραμματοσειρά,την στοίχιση και άλλες ιδιότητες. Ένα αρχείο HTML δεν έχει ανάγκη από compiler. Ο κώδικας γράφεται σε ένα text αρχείο και ένα πρόγραμμα, όπως ο Internet Explorer της Microsoft, αναλαμβάνει την εκτέλεση. Για περισσότερες πληροφορίες για την γλώσσα HTML μπορείτε να ανατρέξετε σε βιβλίο του είδους Τρόπος εμφάνισης κειμένου Τα tags που αναφέραμε είναι εντολές που περιέχονται μέσα σε <, >. Όταν το κείμενο περιέχει τέτοια σύμβολα πρέπει να τα αντικατασταθούν με τα < και > αντίστοιχα για να μην υπάρξεί σύγχυση. Για την εμφάνιση του κώδικα της C++ στην HTML σελίδα πρέπει να ληφθούν υπόψη και άλλοι παράμετροι: Την εμφάνιση των λέξεων-κλειδιά με έντονους χαρακτήρες(βλ:παράρτημα Α) Την εμφάνιση των άγκιστρων με έντονους χαρακτήρες, Το μπλε χρώμα των κειμένων και των αριθμών (HEX #0000FF) To μοβ χρώμα των σχολίων (HEX #00005F) και την πλάγια μορφή τους Ονόματα αποθήκευσης αρχείων Από κάθε όνομα αρχείου πρέπει να απουσιάζουν κάποιοι χαρακτήρες. Οι χαρακτήρες αυτοί είναι οι:, <, >. Αυτοί οι χαρακτήρες μπορούν να αντικατασταθούν με τους _, (, ) αντίστοιχα Ανάγνωση σχολίων 19

20 Πριν από κάθε δήλωση υπάρχουν σχόλια. Τα σχόλια είναι απαραίτητα για την δήλωση περαιτέρω χαρακτηριστικών μιας δήλωσης. Η έναρξη τους χαρακτηρίζεται από μία συνεχή εμφάνιση του χαρακτήρα /. Οι απαιτήσεις αναφέρονταί σε πέντε τέτοιες εμφανίσεις. Το τέλος των σχολίων ορίζεται με τον ίδιο τρόπο με της έναρξης. Κάθε γραμμή των σχολίων ξεκινάει με την διπλή εμφάνιση του χαρακτήρα / και τελειώνει με την αλλαγή γραμμής Περιεχόμενα σχολίων Για την αναγνώριση του περιεχόμενου των σχολίων κρίνεται αναγκαία ο ορισμός λέξεων-κλειδιά. Κάθε τέτοιο κλειδί πρέπει να ξεκινάει με τον και να λήγει με τον χαρακτήρα ϊ. Το περιεχόμενο κάθε ορισμού ξεκινάει μετά την αναγνώριση της λέξης-κλειδί και τελειώνει πριν την εύρεση της επόμενης. Οι λέξεις κλειδιά με την σημασία τους και τον εναλλακτικό ορισμό τους αναφέρονταί παρακάτω: Πίνακας 1. Λ έξεις κλειδιά με την σ η μ α σ ία το υ ς όνομα εναλλακτικά ονόματα σημασία date 0Date θημερομηνία Η ημερομηνία συγγραφής της δήλωσης programmer 0programmer 0Author θπρογραμματ ίοτής θπρογραμματ ίστρια Το όνομα του συγγραφέα της δήλωσης description 0description θπερ Lγραφή Η περιγραφή της δήλωσης exceptions 0exceptions θεξα ίρέσε Lg Οι εξαιρέσεις που προκαλεί η δήλωση specifications 0Specifications θπροδ ίαγραφές Οι προδιαγραφές της δήλωσης speconstr 0Specializations Constraints θπερ Lop ίομο ί Εξε l5 lκευσης Οι περιορισμοί εξειδίκευσης comments 0Comments θσχόλία θπαρατηρήσε Lg Τα σχόλια για την δήλωση. 20

21 calls 0Calls θκαλεl Οι δηλώσεις που καλεί calledby 0CalledBy ΘΚαλείταl Οι δηλώσεις που την καλούν variables 0Variables θμεταβλητ ές Οι μεταβλητές που έχει constants 0Constants θσταθερές Οι σταθερές που έχει exceptionclass 0Exception Class θκλάση Εξαιρέσεων Το όνομα της κλάσης εξαιρέσεων που έχει η κλάση friendfunct 0friend Fucntion θσυνάρτηση Friend θφίλη Συνάρτηση Δήλωση ότι είναι φίλη συνάρτηση σε μία κλάση inherits 01nherits θκληρσνσμε ί Η κλάση από την οποία κληρονομεί τις ιδιότητες της. library 0Library ΘΒ Lβλισθήκη Το όνομα της βιβλιοθήκης οπού ανήκει. invariant 01nvariant θαναλλσ ίωτη Η αναλλοίωτη που ισχύει initialver 01nitial Υσηείση θαρχική Σύνθεση Δήλωση ότι δεν έχει τροποποιηθεί NewVer 0New Υσηείση θμετατρσπή Έχει τροποποιηθεί και που βρίσκεται η προηγούμενη σύνθεση members 0Members θμέλη Τα μέλη μίας κλάσης params 0Parameters θπαράμετρσ l Οι παράμετροι με την περιγραφή τους program θprσgram θπρόγραμμα Σε ποιο πρόγραμμα ανήκει usesglo 0Uses 61σΒη1 θχρησιμσπσ lε ί Καθσλικά Ποια καθολικά αντικείμενα χρησιμοποιεί 21

22 updateglo 0Updates Global Ποια καθολικά αντικείμενα θενημερώνε l Καθολικά τροποποιεί Τρόπος αναγνώρισης σχολίων Για μία λέξη-κλειδί υπάρχουν διαφορετικές ονομασίες, σε Αγγλικά και Ελληνικά. Τα κεφαλαία και τα πεζά δεν πρέπει να παίζουν ρόλο στην ανάγνωση τους. Ρόλο δεν πρέπει να παίζει εάν η λέξη περιέχει λατινικά η Ελληνικά γράμματα που μοιάζουν ίδια στην κεφαλαία μορφή τους. Τα γράμματα αυτά είναι: Ά, 'Β', Τ, Ό', Τ', 'Ζ', Ή',Ύ', 'X', 'Μ', 'Ρ', 'Ν' Για την αναγνώριση μιας λέξης-κλειδί πρέπει να μετατραπεί σε κεφαλαία μορφή και τα παραπάνω Ελληνικά γράμματα που περιέχει στα αντίστοιχα λατινικά Τύπος δηλώσεων Μετά από κάθε σχόλιο πρέπει να υπάρχει μία δήλωση. Ο τύπος της δήλωσης καθορίζεται από την τιμή που έχει το πεδίο της λέξης κλειδί Type. Οι τύποι δήλωσης με την σημασία τους και τον εναλλακτικό ορισμό τους αναφέρονται παρακάτω Πίνακας 2 Τύπ οι δ ή λ ω σ η ς με την σ η μ α σ ία το υς όνομα εναλλακτικά ονόματα σημασία Class Class Κλάση Ακολουθεί κλάση ClassTemplate Class Template Περίγραμμα Κλάσης Ακολουθεί περίγραμμα κλάσης Function Function Συνάρτηση Methσd Μέθσδσς Ακολουθεί συνάρτηση ή διαδικασία Constructor Cσnstructσr Δημ ίσυργός Ακολουθεί δημιουργός κλάσης CopyConstructor Οσργ Cσnstructσr Δημ ίσυργός Αντ Lγραφής Ακολουθεί δημιουργός αντιγραφής DefaultConstructor Default Canstructar Δημίσυργός Ερήμην Ακολουθεί Ερήμην δημιουργός 22

23 Destructor Destructor Καταστροφέας Ακολουθεί καταστροφέας friendfucntion Friend Fucntion Συνάρτηση Friend Φίλη Συνάρτηση Ακολουθεί φίλη συνάρτηση FunctionTemplate Functiσn Template Περίγραμμα Συνάρτησης Ακολουθεί περίγραμμα συνάρτησης Ανάγνωση Παραμέτρων Κατά τις απαιτήσεις λογισμικού το πρόγραμμα πρέπει να διαβάζει τις εισόδους από την γραμμή εντολών του MS-Dos. Με αυτό το σκεπτικό Μπορεί αργότερα να δημιουργηθεί ένας Wizard που να εκτελεί το πρόγραμμα με τις κατάλληλες παραμέτρους θέτοντας στον χρήστη απλές ερωτήσεις. Υπάρχουν δύο είδη παραμέτρων, οι διακόπτες και οι μεταβλητές. Στην πρώτη κατηγορία υπάγονται παράμετροι που με την εμφάνισή τους αλλάζουν την κατάσταση στις αντίστοιχες λογικές μεταβλητές, όπως η εμφάνιση ελληνικών κειμένων και όχι αγγλικών. Στην δεύτερη κατηγορία υπάγονται παράμετροι που η εμφάνισή τους σηματοδοτεί την έναρξη ανάγνωσης μιας μεταβλητής, όπως η θέση ενός αρχείου. Οι παράμετροι εισέρχονται στο πρόγραμμα από την γραμμή εντολών του MS-Dos μετά από το όνομα του προγράμματος. Κάθε παράμετρος πρέπει να αρχίζει με μία παύλα (-). Παράδειγμα : iidoc -File c:\test.cpp - Greek -Log c:\log.txt Οι παράμετροι με το όνομα τους, την σημασία και τον τύπο τους αναφέρονται παρακάτω. Πίνακας 3 Οι π α ρ ά μ ετρ ο ι με την σ η μ α σ ία το υς όνομα σημασία τύπος -file To όνομα του αρχείου προς επεξεργασία Μεταβλητή -h -help Εμφάνιση βοήθειας στην οθόνη και τερματισμός του προγράμματος Διακόπτης -greek Εξαγωγή αρχείων στα ελληνικά. Προκαθορισμένη μεταβλητή αγγλικά Διακόπτης -stayinfile Το πρόγραμμα διαβάζει μόνο το αρχείο που δηλώθηκε στο -file Διακόπτης 23

24 -noindex Δεν δημιουργεί αρχείο πλοήγησης Διακόπτης -path Η περιοχή του δίσκου που θα γίνει αποθήκευση της τεκμηρίωσης Μεταβλητή -debug Εμφάνιση μέσα στο log αρχείο σχόλια λειτουργίας του προγράμματος Διακόπτης -log Το όνομα του αρχείου που θα αποθηκευτούν τα λάθη και οι υποδείξεις του προγράμματος Μεταβλητή 24

25 κε(ράλαιο 4 Κώδικας γενικής χρήσης για το iidoc 4.1 Εισαγωγή Σε αυτό το κεφάλαιο θα αναλύσουμε τον κώδικα που γράφτηκε για το iidoc. Ιδιαίτερη προσπάθεια έγινε ώστε κάθε ενότητα να αποτελεί ανεξάρτητο εκπαιδευτικό υλικό. Κάθε παράγραφος αποτελεί συνέχεια της προηγούμενης, αλλά μπορεί να μελετηθεί και αυτόνομα. Όλα τα προγραμματιστικά θέματα θα λυθούν με αντικειμενοστραφή προγραμματισμό στην γλώσσα C++. Εάν δεν είστε εξοικειωμένοι με την γλώσσα δεν θα μπορέσετε να κατανοήσετε πλήρως αυτά που ακολουθούν στο κεφάλαιο. Για κάθε κλάση και συνάρτηση υπάρχει τεκμηρίωση από το πρόγραμμα iidoc στο παράρτημα Β. 4.2 Δημιουργία Log αρχείων Log αρχεία ονομάζονται τα κείμενα που περιέχουν πληροφορίες για το πώς κινήθηκε ένα πρόγραμμα. Περιέχει σύντομες προτάσεις που δείχνουν τη ροή που ακολούθησε. Προγραμματιστικά για να υλοποιηθεί κάτι τέτοιο πρέπει να υπάρχει ένα καθολικό αντικείμενο, σε όλο το πρόγραμμα, που εκεί θα προσθέτονται κείμενα που χαρακτηρίζουν κάθε φορά τις επιμέρους εργασίες. Ένα Log αρχείο επίσης μπορεί να χρησιμοποιηθεί για να γνωστοποιήσει κάποια λάθη προγράμματος στον χρήστη Η κωδικοποίηση Θα δημιουργήσουμε μία κλάση με όνομα Log. Για να εισάγουμε κείμενα πρέπει να έχουμε μία μεταβλητή τύπου string με όνομα logstr. Ο χρήστης της κλάσης δεν πρέπει να γράφει απευθείας στην μεταβλητή για αυτό καλό είναι να τον προμηθεύσουμε με έναν operator που θα του δίνει την δυνατότητα αυτή, class Log private: string logstr; piiblic: Log(); Logs operator«(string s); -Log(); ;//Log 25

26 Logs Log:: operator«(string s) logstr.append(s); re turn * thi s ; //Log::operator«Με την παραπάνω κλάση ο χρήστης μπορεί να εισάγει κείμενα. Για την εμφάνιση τους όμως; Θα πρέπει να δίνεται η δυνατότητα εμφάνισης στην οθόνη ή σε αρχείο κειμένου. Για να γίνει αυτό πρέπει να υπάρχει μία μεταβλητή που να δηλώνει το όνομα του αρχείου προς αποθήκευση, και φυσικά την ανάλογη συνάρτηση ορισμού. Εάν δεν έχει οριστεί ένα όνομα τότε τα κείμενα εμφανίζονται στην οθόνη. Η εξαγωγή αυτή τοποθετείται στον καταστροφέα της κλάσης. Log::~Log() if (filename=="none") cout«logstr; else ofstream file; file.open(sfilename[0] ); i f (!file) else c out«logstr«endl«"asv υπάρχει το αρχείο για την αποθήκευση του log."«endl; file«logstr; file.close(); //Log::~Log Μία δυνατότητα που έχει προστεθεί είναι η χρήση tabs. Ο χρήστης μπορεί να δημιουργεί εσοχές κατά γραμμή. Όταν εισάγεται ένα tab η εσοχή εμφανίζεται και σε όλες της γραμμές που ακολουθούν μέχρι να αφαιρεθεί. void Log::addTab() 26

27 ++tabs; //Log::addTab void Log::decTab() if (tabs>0) tabs; //Log::decTab H κλάση Log class Log private: string logstr; string filename; int tabs; bool puttab; piiblic: void addtab(); void dectab(); Log(); void setfilename(string name); Logs operator«(string s); -Log(); ;//Log void Log::addTab() ++tabs; //Log::addTab void Log::decTab() if (tabs>0) tabs; //Log::decTab void Log::setFileName(string name) 27

28 filename=name; //Log::setFileName Logs Log:: operator«(string s) i f (puttab) for (int i=0;i<tabs;++i) logstr.append(" "); puttab=false; if (s [s.length()-1]=='\n') puttab=true; logstr.append(s); re turn * thi s ; //Log: :operator«log::log() logstr=""; filename="none"; tabs=0; puttab=true; //Log::Log Log::~Log() if (filename=="none") cout«logstr; else ofstream file; file.open(sfilename[0] ); i f (!file) c out«logstr«endl«"asv υπάρχει το αρχείο για την αποθήκευση του log."«endl; else file«logstr; 28

29 file.close(); //Log::~Log 4.3 Διαχείριση των παραμέτρων ενός προγράμματος Όταν ένα πρόγραμμα της C ή της C++ εκτελείται, η γραμμή εντολών εισέρχεται στην main() με την μορφή δύο παραμέτρων. Όπως κάθε παράμετρο μίας συνάρτησης, έτσι και αυτές μπορείς να τις ονομάσεις όπως θέλεις αρκεί να είναι του σωστού τύπου. Συνηθίζεται όμως να ονομάζουμε τις παραμέτρους argc( από «argument count») και argv (από «argument values»). Η argc είναι ένας ακέραιος που περιέχει τον αριθμό των παραμέτρων της γραμμής εντολών μαζί και με το όνομα του προγράμματος. Η argv είναι ένας πίνακας από βέλη προς χαρακτήρες. Κάθε στοιχείο του πίνακα αναφέρεται σε ένα αλφαριθμητικό που περιέχει τις παραμέτρους από την γραμμή εντολών, έχοντας ως πρώτο στοιχείο το όνομα του προγράμματος. Η δήλωση της main( ) μπορεί να εμφανιστεί ως main(int argc,char **argv) ή συνήθως ως main(int argc,char *argv[ ]). Και στις δύο περιπτώσεις η argv[0] παρέχει ένα βέλος προς το πρώτο γράμμα του ονόματος της εφαρμογής μας, η argv[1] βέλος προς την πρώτη παράμετρο, η argv[2] στη δεύτερη... Ακολουθεί ένα παράδειγμα που εμφανίζει τις παραμέτρους του στην οθόνη : #include <iostream> main(int argc, char **argv) for(int i=0; Kargc; i++) cout«"arg[" < < i «"] is '«argv[ i]«endl; [Bruce Eckel 1993 ] Όταν ένα πρόγραμμα χρειάζεται αρχικές τιμές από τον χρήστη,μία κλάση που μπορεί να διαχειρίζεται τέτοιες παραμέτρους κρίνεται αναγκαία. Χρειάζεται να γράψουμε μία κλάση που θα παίρνει τις μεταβλητές αυτές, θα αναγνωρίζει τις παράμερους που περιέχονται και θα προσφέρει συναρτήσεις ανάγνωσης των δεδομένων. Εάν δηλαδή ο χρήστης περάσει ως παράμετρο στο πρόγραμμα iidoc τους διακόπτες -Greek και -file test.cpp η κλάση να έχει συναρτήσεις bool greeko και string fileq αντίστοιχα. Μπορείτε να ανατρέξετε στην παράγραφο για πληροφορίες που αφορούν τα είδη των παραμέτρων Η κωδικοποίηση 29

30 Θα υλοποιήσουμε μία κλάση με το όνομα switches. Κατά την δημιουργία του αντικείμενου της θα δέχεται τις παραμέτρους της main argc και argv. Για κάθε παράμετρο που θέλουμε να προσθέσουμε θα δηλώνουμε μία μεταβλητή με τον κατάλληλο τύπο και μία συνάρτηση ανάγνωσης της μεταβλητής. Μέσα στον δημιουργό της κλάσης θα γίνεται η ανάγνωση των παραμέτρων. Για το πρώτο είδος παραμέτρων η ανάγνωση είναι απλή αλλά για το δεύτερο είδος χρειάζεται μία συνάρτηση που θα παίρνει τα ορίσματα και θα επιστρέφει την τιμή. bool get arg(const char* sw, strings str int& i,int argc, char** argv) if ( str == sw ) i f ( ++i >= argc ) s log«"asinsl το τέλος του διακόπτη '"<<argv[i-] «" '\η"; m ok = false; return false; str = argv[i]; return true; return false; //get_arg Με την χρήση της παραπάνω συνάρτησης μπορούμε να δώσουμε την πρώτη έκδοση της κλάσης. class switches public: switches(int argc,char** argv); bool greek() const return m greek; bool o k () const return m ok; string file name () const return m file name; private: bool m ok; bool m greek; string m file name; bool get arg(const char* sw,strings str,ints i,int argc,char** argv); ;//switches bool switches::get arg (const char* sw, strings str ints i,int argc, char** argv) 30

31 if ( str == sw ) i f ( ++i >= argc ) s log«"a Ln L το τέλος του διακόπτη '"<<argv[i-] «" '\η"; m ok = false; return false; str = argv[i]; return true; return false; //switches::get arg switches::switches(int argc,char** argv) m ok = true; m file name="none"; m greek=false; // Process the switches. for(int i=0;i<argc;++i) i f (argv[i]) string str = argv[i]; i f ( str == "-h" II str == "-help" ) // Help was specified, report // the usage and exit. //help (); m ok = false; break; i f ( str == "-greek") m greek= true; continue; i f ( get arg("-file",str,i,argc,argv) )m file name=str; continue; //switches::switches Προσθήκη νέων παραμέτρων στην κλάση 31

32 Για κάθε νέα παράμετρο που θέλετε να εισάγετε πρέπει να ακολουθήσετε τα παρακάτω βήματα: Ορίστε το είδος που υπάγετε η παράμετρος Προσθέστε την μεταβλητή που θα αποθηκεύεται η παράμετρος στην περιοχή private στην κλάση. Το όνομα κάθε μεταβλητής πρέπει να ξεκινάει με τους χαρακτήρες m_. Για το πρώτο είδος η μεταβλητή συνηθίζεται να έχει τύπο bool. Συντάξτε μία συνάρτηση, στην περιοχή public της κλάσης, που θα επιστρέφει την τιμή της μεταβλητής που ορίσατε παραπάνω. Δώστε αρχική τιμή στην μεταβλητή στον κώδικα του δημιουργού της κλάσης. Προσθέστε μια if στην περιοχή ανάγνωσης των παραμέτρων,μέσα στον δημιουργό, που θα δίνει τιμή στην μεταβλητή σας. Παράδειγμα: Προσθέστε μία παράμετρο που θα ορίζει το όνομα του Log αρχείου του προγράμματος. class switches piiblic: private: string log name() const return m log name;//log name string m log name; ;// switches switches::switches(int argc,char** argv) m log name="none"; for(..) i f ( get arg("-log",str,i,argc,argv)) m log name= str; continue; // switches::switches 32

33 Με παρόμοιο τρόπο εισήχθησαν και οι άλλοι παράμετροι που αναφέρονται στην παράγραφο και στις απαιτήσεις λογισμικού Ορισμός του τρέχοντος φακέλου από τον χρήστη Όταν χρησιμοποιούμε αρχεία στον προγραμματισμό τα ανοίγουμε χρησιμοποιώντας μόνο το όνομα τους,αφού θεωρούμε ότι υπάρχουν μέσα στον ίδιο υποφάκελο με το πρόγραμμα. Όταν όμως ο χρήστης καλέσει το πρόγραμμα και ο ίδιος βρίσκεται σε άλλο φάκελο τότε ο τρέχων φάκελος δεν είναι ο υποφάκελος του προγράμματος αλλά ο φάκελος που βρισκόταν ο χρήστης πριν την εκτέλεση του προγράμματος. Αυτό θα δημιουργήσει πρόβλημα κατά την εργασία με αρχεία αφού τα αρχεία θα αποθηκευτούν στον τρέχων φάκελο. Παρόμοιο πρόβλημα παρουσιάστηκε στο iidoc. Δεν θα αναλυθεί το πρόβλημα αλλά η λύση σε αυτή την παράγραφο. Πρέπει σαν τρέχων φάκελος να γίνει ο φάκελος που υπάρχει στην παράμετρο filename. Η μετακίνηση του τρέχων φακέλου γίνεται με την εντολή chdir() του dir.h αρχείου. Το πρόβλημα δεν λύνεται τόσο απλά γιατί στην παράμετρο filename είναι αποθηκευμένο εκτός από τον φάκελο και ένα όνομα αρχείου. Μετά από την αλλαγή του τρέχων φακέλου η μεταβλητή πρέπει να έχει μόνο το όνομα χωρίς τον φάκελο που ανήκει. Ό κώδικας που περνούσε την παράμετρο στην μεταβλητή (m_file_name=str;continue;) γίνεται: #include <stdlib> #include <dir> char drive[maxdrive]; char dir[maxdir]; char file[maxfile]; char ext[maxext]; int flags; flags=fnsplit(&str[0],drive,dir,file,ext); string tmp; tmp=""; if(flags & DRIVE) tmp.append(drive); if(flags & DIRECTORY) tmp.append(dir); if (tmp.length()>0) chdir(&tmp[0]); tmp=""; if(flags & FILENAME) tmp.append(flie); if(flags & EXTENSION) tmp.append(ext); 33

34 m file name=tmp; continue; H κλάση Switches class switches public: switches(int argc,char** argv); bool debug() const return m debug; bool greek() const return m greek; bool o k () const return m ok; string program name() const return m program name; string file name() const return m file name string path name() const return m path name string log name() const return m log name bool stayo const return m stayinfile;//stay bool no index() const return m no index;//stay void help() const; string m path name; private: bool m ok; bool m debug; bool m StayInFile; bool m greek; bool m no index; string m program name; string m log name; string m file name; bool get arg(const char* sw,strings str,int& i,int argc,char** argv); ;//switches bool switches::get arg(const char* sw, strings str,ints I,int argc, char** argv) if ( str == sw ) i f ( ++i >= argc ) 34

35 s log «"EUelo: EaB5ae δϊ oyelo δϊδ δέδδϋδδς «argv[i-l] «'"\n"; m ok = false; return false; str = argv[i] ; return true; return false; //switches::get arg switches::switches(int argc,char** argv) m ok = true; m program name = argv[0]; m file name="none"; m log name="none"; m debug=false; m greek=false; m stayinfile=false; m no index=false; if (debug) s log«" Debug : ^ianlg aiaai^nedgd δύΐ aeaei5d^i.\n"; // Process the switches. for(int i=0;i<argc;++i) i f (argv[i]) string str = argv[i]; i f ( str == "-h" II str == "-help" ) // Help was specified, report // the usage and exit. //help (); m ok = false; break; i f ( str == "-debug") m debug= true; continue; i f ( str == "-greek") m greek= true; continue; 35

36 i f ( str == "-stayinfile) m stayinfile= true; continue; i f ( str == "-noindex) m no index= true; continue; continue; continue; i f ( get arg("-path",str,i,argc,argv) ) m path name i f ( get arg("-log",str,i,argc,argv) ) m log name i f ( get arg("-file",str,i,argc,argv) ) = str; = str; #include <stdlib> #include <dir> char drive[maxdrive]; char dir[maxdir]; char file[maxfile]; char ext[maxext]; int flags; flags=fnsplit(&str[0],drive,dir,file,ext); string tmp; tmp=""; i f (flags & DRIVE) tmp.append(drive); if (flags & DIRECTORY) tmp.append(dir); if (tmp.length()>0) chdir(&tmp[0]); tmp=""; if (flags & FILENAME) tmp.append(flie); if (flags & EXTENSION) tmp.append(ext); m file name=tmp; continue; 36

37 if (debug) s log«"debug : OYeio aiaai^neogo oui aeaeido^i.\n"; //switches::switches 4.4 Ανάγνωση αρχείων κειμένου Ένα κείμενο που βρίσκεται σε ένα μέσο αποθήκευση του ΗΛ' ονομάζεται αρχείο κειμένου. Κάθε αρχείο χαρακτηρίζεται από ένα όνομα και μία κατάληξη. Το πρόγραμμα iidoc χρειάζεται να διαβάζει αρχεία C++. Αυτά τα αρχεία δεν είναι τίποτα άλλο παρά αρχεία κειμένου με κατάληξη ορρ. Λόγο που η ανάγνωση αρχείων κειμένου είναι δύστροπη χρειάζεται να γίνει η μεταφορά των δεδομένων σε ένα string αντικείμενο. Για περισσότερες πληροφορίες στο θέμα ανατρέξτε σε κάποιο εγχειρίδιο της C Η κωδικοποίηση Για την μεταφορά των δεδομένων που υπάρχουν από ένα αρχείο κειμένου σε ένα string μπορούμε να αναπτύξουμε κώδικα που να αντιγράφει χαρακτήρα - χαρακτήρα. while(f.get(ch)) text.append(ch); Οπού f TOαντικείμενο αρχείου, text το αντικείμενο string και ch ένας χαρακτήρας. Αυτή η μέθοδος εάν και είναι σωστή είναι πάρα πολύ αργή! Ένας δεύτερος τρόπος αναλύεται στο 7 κεφάλαιο του βιβλίου «προγραμματισμός με τη γλώσσα C++» του Θ. Αλεβίζου. f.open("file.txt",128); char * t ; long mikos; f.seekg(0,2); mikos=f.tellg(); t= new char[mikos+1]; f.seekg(0); f.read(t,mikos); t[mikos]='\0'; text=t; 37

38 ο παραπάνω κώδικας μεταφέρει στην μεταβλητή t τους χαρακτήρες από 0 έως mikos του αρχείου κειμένου f. Στη συνέχεια εισχωρεί την μεταβλητή t στην string μεταβλητή text. Ο συγκεκριμένος τρόπος εάν και είναι με μεγάλη διαφορά πιο γρήγορος μεταφέρει στην string μεταβλητή έναν χαρακτήρα \r. Αυτός ο χαρακτήρα προκαλεί μεταφορά του οθονοδείκτη στην αρχή τηζ ΥΡαρρήζ- Αυτό όχι μόνο δεν είναι απαραίτητο, αφού γίνεται αυτόματα από τον χαρακτήρα \η, αλλά δημιουργεί και προβλήματα. Για αυτό τον λόγο πρέπει να προσθέτει ένα κομμάτι κώδικα, αμέσως μετά του παραπάνω, που αφαιρεί τον προαναφερθέντα χαρακτήρα. int thesi=text.find('\r'); while( 0<=thesi&&thesi<text.length()) text.replace(thesi,1,""); thesi=text.find('\r',thesi+1); Έτσι μαζί με τους ελέγχους καταλήγουμε στην παρακάτω συνάρτηση. bool loadfile(string name) ifstream f; f.open(&name[0],128);//ios::in ios::nocreate) ; if (debug) s log«"debug : Έναρξη ανοίγρατος του αρχείου.\η"; if (name=="none") s log«" Error : Δεν έχει καθοριστεί αρχείο για parsing. \η"; ok=false; return false; else i f (!f.good()) s log«"error : Λεν μπορεί να ανοιχτεί το αρχείο "«name«"\n"; ok=false; return false; else if (debug) s log«" Debug : Έναρξη διαβάσματος του αρχείου.\η"; char * t ; long mikos; f.seekg (0,2) ; 38

39 mikos=f.tellg(); t= new char[mikos+1]; f.seekg(0); f.read(t,mikos); t[mikos] = '\0 '; text=t; //euresi tou \r int thesi=text.find('\r'); while( 0<=thesi&&thesi<text.length ()) text.replace(thesi,1,""); thesi=text.find('\r',thesi+1); if (debug) s log«" Debug : Τέλος διαβάσματος του αρχείου.\η"; f.close () ; if (debug) s log«"debug : Τέλος ανοίγματος του αρχείου.\η"; ok=true; return true; //file:iloadfile H κλάση file class file private: string text; public: bool ok; inline string gettext(); fileo ; file(switches sw); file (string name); bool loadfile(string name); ;//file 39

40 inline string file::gettext() return text; //gettext file::file(string name) text=""; ok=loadfile(name); //file::file file::file(switches sw) text=""; ok=loadfile(sw.file name()); //file::file file::file() text=""; ok=false; //file::file bool file::loadfile(string name) ifstream f; f.open(&name[0],128);//ios::in ios::nocreate) ; if (debug) s log«"debug : Έναρξη ανοίγματος του αρχείου.\η"; if (name=="none") s log«" Error : Δεν έχει καθοριστεί αρχείο για parsing.\η"; ok=false; return false; else i f (!f.good()) 40

41 s log«"error : Δεν μπορεί να ανοικτέ ί το αρχείο "«name«"\n"; ok=false; return false; else if (debug) s log«" Debug : Έναρξη διαβάσματος του αρχείου.\η"; char * t ; long mikos; f.seekg (0,2) ; mikos=f.tellg (); t= new char[mikos+1]; f.seekg(0); f.read(t,mikos); t[mikos] = '\0'; text=t; //euresi tou \r int thesi=text.find('\r'); while( 0<=thesi&&thesi<text.length ()) text.replace(thesi,1,""); thesi=text.find('\r',thesi+1); if (debug) s log«" Debug : Τέλος διαβάσματος του αρχείου.\η"; f.close () ; if (debug) s log«"debug : Τέλος ανοίγματος του αρχείου.\η"; ok=true; return true; //file::loadfile 4.5 Συναρτήσεις διαχείρισης κειμένων Η κλάση string μας προσφέρει αρκετές συναρτήσεις για την διαχείριση της αλλά εξειδικευμένες εργασίες, όπως ανάποδη ανάγνωση κειμένων, δεν μπορεί να υλοποιηθούν άμεσα. Σε αυτή την παράγραφο θα αναλύσουμε συναρτήσεις που θα χρησιμοποιηθούν για διαχείριση κειμένων (string). 41