Rozszerzenie COM z AutoIt - krótkie wprowadzenie

Czym jest COM?

COM oznacza "Component Object Model". Jest to droga Microsoft do łączenia oprogramowania przy użyciu wspólnego interfejsu. Interfejsy te są zdefiniowane w obiektach COM.

Obiekty COM

W naszych przykładach będziemy mieli do czynienia z obiektami. Czym one są w technologii COM? Otóż, każdy obiekt zawiera w sobie pewne zbiory danych oraz funkcji, które działają na tych danych.

Obiekty COM charakteryzują się tym, że dostęp do danych obiektu realizowany jest wyłącznie poprzez jeden lub kilka zbiorów funkcji powiązanych z obiektem.

Te zbiory funkcji są nazywane interfejsami, a poszczególne funkcje z danego zbioru nazywane są metodami.

Czy konieczne jest używanie obiektów COM w skryptach AutoIt?

To po prostu zależy. Autoit ma wiele wbudowanych funkcji oraz ogromną bibliotekę UDF. Można z ich pomocą napisać prawie każdy program. Jednak jeśli potrzebujesz szczególną procedurę z użyciem interfejsów innych aplikacji, za pomocą obiektów COM może zaoszczędzić znaczną ilość linii kodu. Czasami jednak użycie obiektów COM jest nieuniknione jeżeli dane zagadnienie np. format dokumentu lub urządzenie, jest możliwe do obsługi tylko z poziomu dodatkowych bibliotek.

Programista musi mieć świadomość, że istnienie obiektów COM uzależnione jest od systemu operacyjnego i zainstalowanego oprogramowania.

Przykład użycia COM w AutoIt

Powiedzmy, że chcesz, zminimalizować wszystkie otwarte okna. Można to zrobić za pomocą zwykłych funkcji AutoIt. Jednak dwie linie kodu z użyciem obiektów COM dadzą ten sam efekt: $oShell = ObjCreate("shell.application") $oShell.MinimizeAll()

Przeanalizujmy pokrótce powyższy przykład. W pierwszym wierszu tworzymy nowy obiekt o nazwie "shell.application". To jest wewnętrzny obiekt Windows, zdefiniowany w bibliotece shell32.dll. Wskaźnik do tego nowego obiektu jest przypisany do zmiennej $oShell. $oShell jest od teraz zmienną obiektową.

W drugiej linii, używamy metody o nazwie "MinimizeAll" do obiektu oShell. Pozwoli to zminimalizować wszystkie okna.

Jeżeli metoda nie przyjmuje żadnych parametrów to nawiasy po jej nazwie można pominąć: $oShell = ObjCreate("shell.application") $oShell.MinimizeAll

UWAGA: Tak naprawdę AutoIt nie jest językiem obiektowym i nie można w nim utworzyć nowego obiektu. Funkcja ObjCreate nie tworzy obiektu lecz jedynie odnośnik (referencję) do już istniejącego. (np. zawartego w systemie operacyjnym, lub innym zainstalowanym programie). Dzieje się to poprzez pobranie wskaźnika do obiektu.

Oczywiście interfejs obiektu „shell.application” nie zawiera tylko jednej metody: $oShell = ObjCreate("shell.application") $oShell.MinimizeAll sleep(2000) $oShell.UndoMinimizeAll sleep(2000) $oShell.SetTime sleep(2000) $oShell.Help sleep(2000) $oShell.ShellExecute("notepad.exe")

W ostatnim wierszu użyliśmy metody z parametrem (metoda „ShellExecute” jest dokładnym odpowiednikiem funkcj AutoIt o tej samej nazwie).

Wszystkie wersje Windows mają ogromną ilość wewnętrznych obiektów dla różnych celów. Także aplikacje, takie jak Excel czy Word mają swój własny zestaw obiektów.

Cała trudność polega na uzyskani informacji o interesujących nas obiektach. Musimy znać nazwy obiektów i zawartych w nich metod. Musimy wiedzieć jakie parametry można przekazać do metod i jakie jest ich działanie.

Dla obiektu "shell.application" pomocna może być strona:

http://msdn.microsoft.com/en-us/library/bb774094.aspx

Aby uzyskać informacje o wszystkich obiektach aktualnie zainstalowanego w systemie, można użyć programu "OLE / COM Object Viewer". To bardzo pomocne narzędzie zostanie opisane w oddzielnym podrozdziale.

Oto jeszcze jeden przykład. Chcielibyśmy, uzyskać kod źródłowy HTML z pewnej strony internetowej. Można skorzystać z funkcji InetGet(), aby zapisać wynik do pliku i pobrać go ponownie za pomocą FileRead(). Ale poniższe linie kodu zrobią to samo: $oHTTP = ObjCreate("winhttp.winhttprequest.5.1") $oHTTP.Open("GET","http://www.AutoItScript.com") $oHTTP.Send() $HTMLSource = $oHTTP.Responsetext

Zmienna $HTMLSource zawiera teraz kompletny kod HTML strony domowej AutoItScript.com.

(Informacje na temat obiektu "winhttp.winhttprequest" można znaleźć na stronie: http://msdn.microsoft.com/en-us/library/aa384106.aspx

Należy pamiętać, że istnienie obiektów zależy od systemu operacyjnego i zainstalowanych w nim programów. Na przykład obiekt winhttp.winhttprequest.5.1 istnieje tylko na komputerach, które mają zainstalowany Internet Explorer co najmniej w wersji 5. Podczas udostępniania skryptów, które wykorzystują obiekty COM, muszą się one znajdować na wszystkich komputerach.

Zmienne obiektowe zachowują się nieco inaczej niż inne rodzaje zmiennych AutoIt. Nie zawierają one realnej wartości, ale wskaźnik do obiektu na zewnętrz skryptu. Nie można na nich wykonywać operacji arytmetycznych, ani stosować operatorów relacji. Przypisanie zmiennej obiektowej innej wartości spowoduje automatycznie zwolnienie obiektu. Można na przykład wymusić usunięcie obiektu przypisując zmiennej obiektowej dowolną liczbę lub tekst. $oHTTP = ObjCreate("winhttp.winhttprequest.5.1") ;tworzenie obiektu $oHTTP=0 ;usunięcie obiektu

Nie musimy usuwać ręcznie obiektów. Jeśli skrypt kończy działanie AutoIt uwalnia wszystkie aktywne odwołania do obiektów, które zostały stworzone w skrypcie. To samo dzieje się w momencie wyjścia z funkcji, w której zdefiniowano lokalną zmienną obiektową.

Z użyciem obiektów COM można "zautomatyzować" wiele popularnych programów. Zamiast korzystać z funkcji AutoIt, takich jak Send() lub WinActivate(), można skorzystać z obiektów, które są zdefiniowane w programie i poprzez nie sterować jego działaniem. Metoda te wymaga wiedzy o dostępnych obiektach i sposobie ich wykorzystania. Najczęściej daje jednak lepsze i pewniejsze rezultaty, a kod skryptu jest krótszy i bardziej czytelny.

Oto przykład,jak można "zautomatyzować" Microsoft Excel: $oExcel = ObjCreate("Excel.Application") ;tworzenie obiektu Excel'a $oExcel.Visible = 1 ;wyświetlenie Excel'a $oExcel.WorkBooks.Add ;dodanie nowego skoroszytu $oExcel.ActiveWorkBook.ActiveSheet.Cells(1,1).Value="test" ;wypełnienie komórki sleep(4000) ;wyświetlanie wyniku przez 4 sek. $oExcel.ActiveWorkBook.Saved = 1 ;symulacja zapisu skoroszytu $oExcel.Quit ;wyjście z Excel'a

WITH..ENDWITH Powyższy przykład możemy zapisać z pomocą konstrukcji programowej WITH..ENDWITH. Jest to rodzaj nawiasów określający, że wszystkie wywołane wewnątrz metody odnoszą się do obiektu o nazwie zmiennej obiektowej podanej po WITH: $oExcel = ObjCreate("Excel.Application") ;tworzenie obiektu Excel'a WITH $oExcel .Visible = 1 ;wyświetlenie Excel'a .WorkBooks.Add ;dodanie nowego skoroszytu .ActiveWorkBook.ActiveSheet.Cells(1,1).Value="test" ;wypełnienie komórki sleep(4000) ;wyświetlanie wyniku przez 4 sek. .ActiveWorkBook.Saved = 1 ;symulacja zapisu skoroszytu .Quit ;wyjście z Excel'a ENDWITH

Analogiczny skrypt dla Libre Office Calc będzie wyglądał tak: Dim $aPar $oSM = ObjCreate("com.sun.star.ServiceManager") $aPar = $oSM.Bridge_GetStruct("com.sun.star.beans.PropertyValue") $oDesktop = $oSM.createInstance("com.sun.star.frame.Desktop") $oCurCom = $oDesktop.loadComponentFromURL( "private:factory/scalc", "_blank", 0, $aPar)

$oCurCom.getSheets.getByIndex(0).getCellByPosition(0,0).String = "test" Sleep(4000) $oCurCom.Close(1)

FOR..IN – pętla po kolekcji Kolekcja (kontener) – struktura danych, której zadaniem jest przechowywanie w zorganizowany sposób zbioru danych lub obiektów. Najprostszą kolekcją jest tablica. Działanie pętli FOR..IN dla tablic zostało omówione w rozdziale AutoIt/Instrukcje sterujące.

Kolekcje obiektów Kolekcja obiektów jest obiektem przechowującym wskaźniki do innych obiektów. Tworzą one jednowymiarową tablicę, w której komórkach są wskaźniki do kolejnych obiektów kolekcji. Analogicznie jak dla zwykłej tablicy, można pobierać te wskaźniki z pomocą pętli FOR..IN.

Poniższy przykład dla Arkusza Excel'a pokazuje sposób użycia pętli po elementach kolekcji (kolekcję stanowią komórki z określonego zakresu arkusza): $oExcel = ObjCreate("Excel.Application") ;tworzenie obiektu Excel'a $oExcel.Visible = 1 ;wyświetlenie Excel'a $oExcel.WorkBooks.Add ;dodanie nowego skoroszytu

dim $arr ;tworzenie tablicy z danymi for $i = 0 to 15 for $j = 0 to 15 $arr[$i][$j] = $i next next

;wpisanie wartości z tablicy do komórek arkusza $oExcel.activesheet.range("A1:O16").value = $arr

sleep(2000)

;w pętli po kolekcji sprawdzanie wartości ;w poszczególnych komórkach arkusza ;jeżeli wartość < 5 to do komórki wstawiamy 0 For $cell in $oExcel.ActiveSheet.Range("A1:O16") If $cell.Value < 5 Then $cell.Value = 0 Endif Next

sleep(2000) $oExcel.ActiveWorkBook.Saved = 1 ;symulacja zapisu skoroszytu $oExcel.Quit

Zaawansowane użycie COM

Opisane dalej sposoby użycia obiektów w AutoIt, wymaga głębokiej znajomości zdarzeń i błędów COM.

Jeśli jesteś nowicjuszem w programowaniu COM, przeczytaj jakąś dobrą dokumentację COM.

Biblią COM jest książka pod tytułem "Inside OLE 2" (Kraig Brockschmidt - Microsoft Press).

Można również znaleźć pewne zasoby COM w Internecie np.:

http://msdn.microsoft.com/en-us/library/ms694363.aspx (wstęp)

http://www.garybeene.com/vb/tut-obj.htm (o obiektach w Visual Basic)

http://java.sun.com/docs/books/tutorial/java/concepts/ (wykorzystanie obiektów w Javie)

http://msdn.microsoft.com/archive/en-us/dnarguion/html/drgui082399.asp (zdarzenia obiektów w C++)

http://www.garybeene.com/vb/tut-err.htm (obsługa błędów w Visual Basic).

COM – programowanie zdarzeniowe Normalna automatyzacja COM wykorzystuje głównie jednostronną komunikację. Nasz skrypt żąda jakiejś odpowiedzi lub działania od metody, a metoda realizuje to żądanie.

Jednak obiekt COM w skrypcie może sam zainicjować działanie. Może to być bardzo przydatne w przypadku, gdy trzeba czekać na jakąś akcję związaną z obiektami COM.

Zamiast tworzenia czegoś w rodzaju pętli i odpytywania w niej obiektu czy coś interesującego nas się wydarzyło, możemy pozwolić aby sam obiekt generował komunikaty o zdarzeniach.

W międzyczasie (prawie) jednocześnie skrypt może wykonywać inne operacje. Gdy obiekt COM wygeneruje komunikat o zdarzeniu, w odpowiedzi na niego nasz skrypt podejmie zaprogramowane działanie.

Nie wszystkie obiekty wspierają zdarzenia, aby się o tym dowiedzieć musimy zapoznać się z ich dokumentacją. AutoIt może odbierać od obiektów COM tylko zdarzenia typu 'dispatch'.

Należy znać nazwy zdarzeń, które obiekt potrafi wygenerować oraz ich argumenty (jeśli są). Jeżeli posiadamy wszystkie te informacje, możemy rozpocząć tworzenie skryptu AutoIt, korzystającego ze zdarzeń COM.

Poniższy przykład pokazuje jak odbierać zdarzenia z Internet Explorer'a: #include "GUIConstantsEx.au3" $GUIMain=GUICreate( "Test obsługi zdarzeń",600,500 ) $GUIEdit=GUICtrlCreateEdit( "Logi:" & @CRLF, 10, 20, 580, 400) $GUIProg=GUICtrlCreateProgress (10, 5, 580, 10) $GUIExit=GUICtrlCreateButton(" Koniec ", 250, 450, 80, 30) GUISetState()

#include "GUIConstantsEx.au3" $GUIMain=GUICreate( "Test obsługi zdarzeń",600,500 ) $GUIEdit=GUICtrlCreateEdit( "Logi:" & @CRLF, 10, 20, 580, 400) $GUIProg=GUICtrlCreateProgress (10, 5, 580, 10) $GUIExit=GUICtrlCreateButton(" Koniec ", 250, 450, 80, 30) GUISetState()

$oIE=ObjCreate("InternetExplorer.Application.1") With $oIE .Visible=1 .Top = (@DesktopHeight-400)/2 .Height=400 ;wysokość GUI IE .Width=600 ;szerokość GUI IE .Silent=1 ;nie pokazuj okien dialogowych IE $IEWnd=HWnd(.hWnd) ;zapamiętanie uchwytu okna IE EndWith

;wybieramy interfejs o nazwie 'DWebBrowserEvents' ;AutoIt, być może, nie potrafiłby znaleźć samodzielnie prawidłowego interfejsu $EventObject=ObjEvent($oIE,"IEEvent_","DWebBrowserEvents") if @error then Msgbox(0,"AutoIt COM test", _ "Nie można użyć interfejsu 'DWebBrowserEvents'. Kod błędu: " & hex(@error,8)) Exit endif

$URL = "http://www.AutoItScript.com/" ;adres strony do wczytania $oIE.Navigate( $URL ) sleep(2000) ;czekanie na załadowanie strony